UID

title

description

old-location

tech.root

ms.date

keywords

ms.keywords

req.header

req.include-header

req.target-type

req.target-min-winverclnt

req.target-min-winversvr

req.kmdf-ver

req.umdf-ver

req.ddi-compliance

req.unicode-ansi

req.idl

req.max-support

req.namespace

req.assembly

req.type-library

req.lib

req.dll

req.irql

targetos

req.typenames

f1_keywords

topic_type

api_type

api_location

api_name

NF:dbgeng.IDebugControl.OutputPromptVaList

IDebugControl::OutputPromptVaList (dbgeng.h)

Learn how the OutputPromptVaList method formats and sends a user prompt to the output callback objects.

debugger\outputpromptvalist.htm

debugger

05/03/2018

IDebugControl::OutputPromptVaList

IDebugControl interface [Windows Debugging],OutputPromptVaList method, IDebugControl.OutputPromptVaList, IDebugControl2 interface [Windows Debugging],OutputPromptVaList method, IDebugControl2::OutputPromptVaList, IDebugControl3 interface [Windows Debugging],OutputPromptVaList method, IDebugControl3::OutputPromptVaList, IDebugControl::OutputPromptVaList, IDebugControl_fc743964-a97c-45d2-8167-0e7401c7a546.xml, OutputPromptVaList, OutputPromptVaList method [Windows Debugging], OutputPromptVaList method [Windows Debugging],IDebugControl interface, OutputPromptVaList method [Windows Debugging],IDebugControl2 interface, OutputPromptVaList method [Windows Debugging],IDebugControl3 interface, dbgeng/IDebugControl2::OutputPromptVaList, dbgeng/IDebugControl3::OutputPromptVaList, dbgeng/IDebugControl::OutputPromptVaList, debugger.outputpromptvalist

dbgeng.h

Dbgeng.h, Stdarg.h

Desktop

Windows

IDebugControl::OutputPromptVaList

dbgeng/IDebugControl::OutputPromptVaList

APIRef

kbSyntax

COM

dbgeng.h

IDebugControl::OutputPromptVaList

-description

The OutputPromptVaList method formats and sends a user prompt to the output callback objects.

-parameters

-param OutputControl [in]

Specifies an output control that determines which of the client's output callbacks will receive the output. For possible values, see DEBUG_OUTCTL_XXX.

-param Format [in, optional]

Specifies the format string, as in printf. Typically, conversion characters work exactly as they do in C. For the floating-point conversion characters, the 64-bit argument is interpreted as a 32-bit floating-point number unless the l modifier is used.

The %p conversion character is supported, but it represents a pointer in a target's address space. It might not have any modifiers and it uses the debugger's internal address formatting. The following additional conversion characters are supported.

Character	Argument type	Argument	Text printed
%p	ULONG64	Pointer in an address space.	The value of the pointer.
%N	DWORD_PTR (32 or 64 bits, depending on the host's architecture)	Pointer in the host's virtual address space.	The value of the pointer. (This is equivalent to the standard C %p character.)
%I	ULONG64	Any 64-bit value.	The specified value. If this is greater than 0xFFFFFFFF, it is printed as a 64-bit value; otherwise, it is printed as a 32-bit value.
%ma	ULONG64	Address of a NULL-terminated ASCII string in the process's virtual address space.	The specified string.
%mu	ULONG64	Address of a NULL-terminated Unicode string in the process's virtual address space.	The specified string.
%msa	ULONG64	Address of an ANSI_STRING structure in the process's virtual address space.	The specified string.
%msu	ULONG64	Address of a UNICODE_STRING structure in the process's virtual address space.	The specified string.
%y	ULONG64	Address in the process's virtual address space of an item with symbol information.	String that contains the name of the specified symbol (and displacement, if any).
%ly	ULONG64	Address in the process's virtual address space of an item with symbol information.	String that contains the name of the specified symbol (and displacement, if any), as well as any available source line information.

If Format is NULL, only the standard prompt text is sent to the output callbacks.

-param Args [in]

Specifies additional parameters that represent values to be inserted into the output during formatting. Args must be initialized using va_start. This method does not call va_end.

-returns

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

Return code	Description
S_OK	The method was successful.

-remarks

OutputPromptVaList and OutputPromptVaListWide can be used to prompt the user for input.

The standard prompt will be sent to the output callbacks before the formatted text described by Format. The contents of the standard prompt is returned by the method GetPromptText.