Skip to content

Latest commit

 

History

History
292 lines (214 loc) · 6.05 KB

nf-dbgeng-idebugcontrol3-output.md

File metadata and controls

292 lines (214 loc) · 6.05 KB
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.IDebugControl3.Output
IDebugControl3::Output (dbgeng.h)
The Output method formats a string and send the result to output callbacks that have been registered with the engine's clients.
debugger\output.htm
debugger
05/03/2018
IDebugControl3::Output
IDebugControl interface [Windows Debugging],Output method, IDebugControl2 interface [Windows Debugging],Output method, IDebugControl2::Output, IDebugControl3 interface [Windows Debugging],Output method, IDebugControl3.Output, IDebugControl3::Output, IDebugControl::Output, IDebugControl_4b29317b-e521-4deb-84dc-fc4bb7d6ca90.xml, Output, Output method [Windows Debugging], Output method [Windows Debugging],IDebugControl interface, Output method [Windows Debugging],IDebugControl2 interface, Output method [Windows Debugging],IDebugControl3 interface, dbgeng/IDebugControl2::Output, dbgeng/IDebugControl3::Output, dbgeng/IDebugControl::Output, debugger.output
dbgeng.h
Dbgeng.h
Desktop
Windows
IDebugControl3::Output
dbgeng/IDebugControl3::Output
APIRef
kbSyntax
COM
dbgeng.h
IDebugControl3::Output

IDebugControl3::Output

-description

The Output method formats a string and send the result to output callbacks that have been registered with the engine's clients.

-parameters

-param Mask [in]

Specifies the output-type bit field. See DEBUG_OUTPUT_XXX for possible values.

-param Format [in]

Specifies the format string, as in printf. In general, conversion characters work exactly as 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 cannot 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.

-param ...

Specifies additional parameters that contain values to be inserted into the output during formatting.

-returns

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

Return code Description
S_OK
The method was successful.

-remarks

When generating very large output strings, it is possible to reach the limits of the debugger engine or of the operating system. For example, some versions of the debugger engine have a 16K character limit for a single output. If you find that very large output is getting truncated, you might need to split your output into multiple requests.

-see-also

.printf

ControlledOutput

IDebugControl

IDebugControl2

IDebugControl3

OutputVaList

dprintf