interface-disconnect

interface-disconnect Function

Summary

Disconnect a sink interface pointer from the source of events in another COM interface pointer.

Package

com

Signature

interface-disconnect &key interface-ptr iid cookie &key errorp => flag

Arguments

`interface-ptr`⇩	A COM interface pointer that provides the source interface `iid`.
`iid`⇩	The iid of the source interface to be disconnected. The iid can be a symbol naming the interface or a refguid foreign pointer.
`cookie`⇩	The integer cookie associated with the connection to be disconnected.
`errorp`⇩	A boolean.

Values

flag

A boolean, true for successful disconnection.

Description

The function interface-disconnect disconnects the connection cookie from the connection point in interface-ptr that matches iid.

If errorp is false, errors disconnecting cookie will cause nil to be returned. Otherwise an error of type com-error will be signaled.

Examples

Suppose there is an interface pointer clonable which provides a source interface i-clonable-events, then the following form can be used to disconnect an implementation of this source interface with cookie cookie:

(interface-disconnect clonable
                      'i-clonable-events
                      cookie)