Input

The Input and InputWide methods request an input string from the debugger engine.

HRESULT
  IDebugControl::Input(
    OUT PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  InputSize
    );

HRESULT
  IDebugControl4::InputWide(
    OUT PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  InputSize
    );

#ifdef UNICODE
#define InputT InputWide
#else
#define InputT Input
#endif

Parameters

Buffer

Receives the input string from the engine.

BufferSize

Specifies the size, in characters, of the buffer that Buffer specifies.

InputSize

Receives the number of characters returned in Buffer. If InputSize is NULL, this information is not returned.

Return Value

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.

Interface Version

Input is available in all versions of IDebugControl. InputWide is available in IDebugControl4 and later versions.

Additional Information

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

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.