ReturnInput

The ReturnInput and ReturnInputWide methods are used by IDebugInputCallbacks objects to send an input string to the engine following a request for input.

HRESULT
  IDebugControl::ReturnInput(
    IN PCSTR  Buffer
    );

HRESULT
  IDebugControl4::ReturnInputWide(
    IN PCWSTR  Buffer
    );

#ifdef UNICODE
#define ReturnInputT ReturnInputWide
#else
#define ReturnInputT ReturnInput
#endif

Parameters

Buffer

Specifies the input string being sent to the engine.

Return Value

S_OK

The method was successful.

S_FALSE

The engine had already received the input it requested. The input string in Buffer was not received by the engine.

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

Interface Version

ReturnInput is available in all versions of IDebugControl. ReturnInputWide 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.