IDebugClient5::SetEventCallbacks method (dbgeng.h)

Article
02/22/2024

The SetEventCallbacks method registers an event callbacks object with this client.

Syntax

HRESULT SetEventCallbacks(
  [in, optional] PDEBUG_EVENT_CALLBACKS Callbacks
);

Parameters

[in, optional] Callbacks

Specifies the interface pointer to the event callbacks object to register with this client.

Return value

Depending on the implementation of the method IDebugEventCallbacks::GetInterestMask in the object specified by Callbacks, other values may be returned, as described in the Remarks section.

Return code	Description
S_OK	The method was successful.

Remarks

If the value of Callbacks is not NULL, the method IDebugEventCallbacks::GetInterestMask is called. If the return value is not S_OK, SetEventCallbacks and SetEventCallbacksWide have no effect and they return this value.

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

The IDebugEventCallbacks interface extends the COM interface IUnknown. When SetEventCallbacks and SetEventCallbacksWide are successful, they call the IUnknown::AddRef method of the object specified by Callbacks. The IUnknown::Release method of this object will be called the next time SetEventCallbacks or SetEventCallbacksWide is called on this client, or when this client is deleted.

For more information about callbacks, see Callbacks.

Requirements

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)