IDebugControl3::GetPromptText method (dbgeng.h)

Article
02/22/2024

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

Syntax

HRESULT GetPromptText(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG TextSize
);

Parameters

[out, optional] Buffer

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

[in] BufferSize

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

[out, optional] TextSize

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

Return value

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

Return code	Description
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.

Remarks

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

Requirements

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