CoDisconnectObject - OLE Programmer's Reference (ole.hlp)

CoDisconnectObject

Disconnects all remote process connections being maintained on behalf of all the interface pointers on a specified object. Only the process that actually manages the object should call CoDisconnectObject.

STDAPI CoDisconnectObject(

IUnknown * pUnk,	//Points to the object
DWORD dwReserved	//Reserved for future use
);

Parameters
pUnk

Points to the object to be disconnected. This does not necessarily have to be an IUnknown pointer. It can be a pointer to any interface supported by the object, as long as the interface is derived from IUnknown.

dwReserved

Reserved for future use; must be zero.

Return Values
S_OK

Indicates all connections to remote processes were successfully deleted.

E_OUTOFMEMORY

Out of memory.

E_INVALIDARG

Indicates one or more arguments are invalid.

E_UNEXPECTED

Indicates an unexpected error occurred.

E_FAIL

Indicates an unspecified error occurred.

Comments
The CoDisconnectObject function is not used in the typical course of processing (clients of interfaces should use IUnknown::Release). The primary purpose of CoDisconnectObject is to give an application control over connections from other processes that were made to objects managed by the application. For example, suppose an OLE container loads an embedded object and then links are established between the embedded object and outside containers. If the container application wants to exit, it is not appropriate for these remote connections to keep the object active beyond the lifetime of its container. When the object's container closes, such links should be disconnected. To forcefully close any existing connection(s), the object's container can call CoDisconnectObject.

Before calling CoDisconnectObject, the container should first call IOleObject::Close for all OLE objects. The objects will send OnClose notifications to inform all clients of the impending closure.

Calling this function is a privileged operation, to be invoked only by the process in which the object is actually managed.

See Also
IOleObject::Close

More Online Helps

Win32 Programmer's Reference (win32.hlp)
Win32 Multimedia Programmer's Reference (mmedia.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (sock2.hlp)
Unix Manual Pages

greatis just4fun network