GetOutputCallbacks

The GetOutputCallbacks and GetOutputCallbacksWide methods return the output callbacks object registered with the client.

HRESULT
  IDebugClient::GetOutputCallbacks(
    OUT IDebugOutputCallbacks * *  Callbacks
    );

HRESULT
  IDebugClient5::GetOutputCallbacksWide(
    OUT IDebugOutputCallbacksWide * *  Callbacks
    );

#ifdef UNICODE
#define GetOutputCallbacksT GetOutputCallbacksWide
#define IDebugOutputCallbacksT IDebugOutputCallbacksWide
#else
#define GetOutputCallbacksT GetOutputCallbacks
#define IDebugOutputCallbacksT IDebugOutputCallbacks
#endif

Parameters

Callbacks

Receives an interface pointer to the IDebugOutputCallbacks object registered with the client.

Return Value

S_OK

The method was successful.

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

Interface Version

GetOutputCallbacks is available in all versions of IDebugClient. GetOutputCallbacksWide is available in IDebugClient5 and later versions.

Comments

Each client can have at most one IDebugOutputCallbacks or IDebugOutputCallbacksWide object registered with it for output.

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

The IDebugOutputCallbacks interface extends the COM interface IUnknown. Before returning the IDebugOutputCallbacks 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

IDebugOutputCallbacks, SetOutputCallbacks