FlushCallbacks

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

HRESULT
  IDebugClient::FlushCallbacks(
    );

Parameters

None

Return Value

S_OK

The method was successful.

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

Interface Version

FlushCallbacks is available in all versions of IDebugClient.

Comments

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

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

See Also

IDebugOutputCallbacks, IDebugOutputCallbacks::Output, DispatchCallbacks