GetPromptText

The GetPromptText and GetPromptTextWide methods return the standard prompt text that will be prepended to the formatted output specified in the OutputPrompt and OutputPromptVaList methods.

HRESULT
  IDebugControl::GetPromptText(
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  TextSize
    );

HRESULT
  IDebugControl4::GetPromptTextWide(
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  TextSize
    );

#ifdef UNICODE
#define GetPromptTextT GetPromptTextWide
#else
#define GetPromptTextT GetPromptText
#endif

Parameters

Buffer

Receives the prompt text. If Buffer is NULL, this information is not returned.

BufferSize

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

TextSize

Receives the size, in characters, of the prompt text. If TextSize is NULL, this information is not returned.

Return Value

S_OK

The method was successful.

S_FALSE

The method was successful. However, the prompt text was too large to fit into the Buffer buffer and the text was truncated.

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

Interface Version

GetPromptText is available in all versions of IDebugControl. GetPromptTextWide is available in IDebugControl4 and later versions.

Comments

For more information about prompting the user, see Using Input and Output.

Requirements

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

See Also

OutputPrompt, OutputPromptVaList