IDebugControl::Input method (dbgeng.h)

Article
02/22/2024

The Input method requests an input string from the debugger engine.

Syntax

HRESULT Input(
  [out]           PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG InputSize
);

Parameters

[out] Buffer

Receives the input string from the engine.

[in] BufferSize

Specifies the size, in characters, of the buffer that Buffer specifies. This size includes the space for the '\0' terminating character.

[out, optional] InputSize

Receives the number of characters returned in Buffer. This size includes the space for the '\0' terminating character. If InputSize is NULL, this information is not returned.

Return value

Return code	Description
S_OK	The method was successful.
S_FALSE	The method was successful. However, the buffer was not big enough to hold the whole input string and it was truncated.

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

Remarks

For an overview of input in the debugger engine, see Input and Output.

Requirements

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