CoIsHandlerConnected function (combaseapi.h)

Article
02/22/2024

Determines whether a remote object is connected to the corresponding in-process object.

Syntax

BOOL CoIsHandlerConnected(
  [in] LPUNKNOWN pUnk
);

Parameters

[in] pUnk

A pointer to the controlling IUnknown interface on the remote object.

Return value

If the object is not remote or if it is remote and still connected, the return value is TRUE; otherwise, it is FALSE.

Remarks

The CoIsHandlerConnected function determines the status of a remote object. You can use it to determine when to release a remote object. You specify the remote object by giving the function a pointer to its controlling IUnknown interface (the pUnk parameter). A value of TRUE returned from the function indicates either that the specified object is not remote, or that it is remote and is still connected to its remote handler. A value of FALSE returned from the function indicates that the object is remote but is no longer connected to its remote handler; in this case, the caller should respond by releasing the object.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	combaseapi.h (include Objbase.h)
Library	Ole32.lib
DLL	Ole32.dll

Share via