IDebugClient5::FlushCallbacks method

The FlushCallbacks method forces any remaining buffered output to be delivered to the IDebugOutputCallbacks object registered with this client.

Syntax

HRESULT FlushCallbacks();

Parameters

This method has no parameters.

Return value

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

Return code Description
S_OK
The method was successful.

Remarks

The engine sometimes merges compatible callback requests to reduce callback overhead; small pieces of output are collected into larger groups to reduce the number of IDebugOutputCallbacks::Output calls. Using FlushCallbacks is necessary for a client to guarantee that all pending callbacks have been processed at a particular point. For example, a caller can flush callbacks before starting a lengthy operation outside of the engine so that pending callbacks are not delayed until after the operation.

For more information about callbacks, see Callbacks.

Requirements

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

See also

DispatchCallbacks

IDebugClient

IDebugClient2

IDebugClient3

IDebugClient4

IDebugClient5

IDebugOutputCallbacks

IDebugOutputCallbacks::Output