DispatchCallbacks

The DispatchCallbacks method lets the debugger engine use the current thread for callbacks.

HRESULT
  IDebugClient::DispatchCallbacks(
    IN ULONG  Timeout
    );

Parameters

Timeout

Specifies how many milliseconds to wait before this method will return. If Timeout is INFINITE, this method will not return until ExitDispatch is called or an error occurs.

Return Value

S_OK

The method was successful (ExitDispatch was used).

S_FALSE

Timeout milliseconds elapsed.

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

Interface Version

DispatchCallbacks is available in all versions of IDebugClient.

Comments

This method returns when Timeout milliseconds have elapsed, ExitDispatch is called, or an error occurs.

Almost all client methods must be called from the thread in which the client was created; callback objects registered with the client are also called from this thread. When DispatchCallbacks is called the engine can use the current thread to make callback calls.

Client threads should call this method whenever possible to allow the callbacks to be called, unless the thread was the same thread used to start the debugger session, in which case the callbacks are called when WaitForEvent is called.

For more information about callbacks, see Callbacks.

Requirements

Headers: Defined in dbgeng.h. Include dbgeng.h. The constant INFINITE is defined in winbase.h.

See Also

ExitDispatch, WaitForEvent, FlushCallbacks