Expand Minimize

IDebugControl::GetPromptText method

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

Buffer [out, optional]

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

BufferSize [in]

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

TextSize [out, optional]

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 codeDescription
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

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugControl
IDebugControl2
IDebugControl3
OutputPrompt
OutputPromptVaList

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.