IDebugControl::OutputDisassemblyLines method (dbgeng.h)

Article
10/21/2021

The OutputDisassemblyLines method disassembles several processor instructions and sends the resulting assembly instructions to the output callbacks.

Syntax

HRESULT OutputDisassemblyLines(
  [in]            ULONG    OutputControl,
  [in]            ULONG    PreviousLines,
  [in]            ULONG    TotalLines,
  [in]            ULONG64  Offset,
  [in]            ULONG    Flags,
  [out, optional] PULONG   OffsetLine,
  [out, optional] PULONG64 StartOffset,
  [out, optional] PULONG64 EndOffset,
  [out, optional] PULONG64 LineOffsets
);

Parameters

[in] OutputControl

Specifies the output control that determines which client's output callbacks receive the output. For possible values, see DEBUG_OUTCTL_XXX. For more information about output, see Input and Output.

[in] PreviousLines

Specifies the number of lines of instructions before the instruction at Offset to include in the output. Typically, each instruction is output on a single line. However, some instructions can take up several lines of output; this can cause the number of lines output before the instruction at Offset to be greater than PreviousLines.

[in] TotalLines

Specifies the total number of lines of instructions to include in the output. Typically, each instruction is output on a single line. However, some instructions can take up several lines of output; this can cause the number of lines output to be greater than TotalLines.

[in] Offset

Specifies the location in the target's memory of the instructions to disassemble. The disassembly output will start PreviousLines lines before these processor instructions.

[in] Flags

Specifies the bit-flags that affect the behavior of this method. The following table lists the bits that can be set.

Bit-Flag	Effect when set
DEBUG_DISASM_EFFECTIVE_ADDRESS	Compute the effective address of each instruction from the current register information and output it.
DEBUG_DISASM_MATCHING_SYMBOLS	If the address of an instruction has an exact symbol match, output the symbol.
DEBUG_DISASM_SOURCE_LINE_NUMBER	Include the source line number of each instruction in the output.
DEBUG_DISASM_SOURCE_FILE_NAME	Include the source file name in the output.

[out, optional] OffsetLine

Receives the line number in the output that contains the instruction at Offset. If OffsetLine is NULL, this information is not returned.

[out, optional] StartOffset

Receives the location in the target's memory of the first instruction included in the output. If StartOffset is NULL, this information is not returned.

[out, optional] EndOffset

Receives the location in the target's memory of the instruction that follows the last disassembled instruction.

[out, optional] LineOffsets

Receives the locations in the target's memory of the instructions included in the output starting with the instruction at Offset. LineOffsets is an array that contains TotalLines elements.

Offset is the value of first entry in this array unless there was an error disassembling the instructions before this instruction. In this case, the first entry will contain DEBUG_ANY_ID and Offset will be placed in the second entry in the array (index one).

If the output for an instruction spans multiple lines, the element in the array that corresponds to the first line of the instruction will contain the address of the instruction.

If LineOffsets 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.

Remarks

The assembly language depends on the effective processor type of the target system. For information about the assembly language, see the processor documentation.

For an overview of using assembly in debugger applications, see Debugging in Assembly Mode. For more information about using assembly with the debugger engine API, see Assembling and Disassembling Instructions.

Requirements

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