GetEventCallbacks

The GetEventCallbacks and GetEventCallbacksWide methods return the event callbacks object registered with this client.

HRESULT
  IDebugClient::GetEventCallbacks(
    OUT IDebugEventCallbacks * *  Callbacks
    );

HRESULT
  IDebugClient5::GetEventCallbacksWide(
    OUT IDebugEventCallbacksWide * *  Callbacks
    );

#ifdef UNICODE
#define GetEventCallbacksT GetEventCallbacksWide
#define IDebugEventCallbacksT IDebugEventCallbacksWide
#else
#define GetEventCallbacksT GetEventCallbacks
#define IDebugEventCallbacksT IDebugEventCallbacks
#endif

Parameters

Callbacks

Receives an interface pointer to the event callbacks object registered with this client.

Return Value

S_OK

The method was successful.

This method may also return error values. See Return Values for more details.

Interface Version

GetEventCallbacks is available in all versions of IDebugClient. GetEventCallbacksWide is available in IDebugClient5 and later versions.

Comments

Each client can have at most one IDebugEventCallbacks or IDebugEventCallbacksWide object registered with it for receiving events.

If no event callbacks object is registered with the client, the value of Callbacks will be set to NULL.

The IDebugEventCallbacks interface extends the COM interface IUnknown. Before returning the IDebugEventCallbacks object specified by Callbacks, the engine calls its IUnknown::AddRef method. When this object is no longer needed, its IUnknown::Release method should be called.

For more information about callbacks, see Callbacks.

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h.

See Also

IDebugEventCallbacks, SetEventCallbacks