Edit

Share via

IDebugInputCallbacks::StartInput method (dbgeng.h)

  • Article

The StartInput callback method is called by the engine to indicate that it is waiting for a line of input.

Syntax

HRESULT StartInput(
  [in] ULONG BufferSize
);

Parameters

[in] BufferSize

Specifies the number of characters requested. Any input longer than this size will be truncated.

Return value

The return value is ignored by the engine unless it indicates a remote procedure call error; in this case the client, with which this IDebugEventCallbacks object is registered, is disabled.

Remarks

This method indicates that the engine is waiting for a line of input from any client. This can occur if, for example, the Input method was called on a client.

After calling this method, the engine waits until it receives some input. When it does receive input, it calls IDebugInputCallbacks::EndInput to inform all the IDebugInputCallbacks objects that are registered with clients that it is no longer waiting for input.

The IDebugInputCallbacks object can provide the engine with a line of input by calling either the ReturnInput or ReturnInputWide methods.

For more information about debugger engine input, see Input and Output.

Requirements

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