Edit

Share via

IDebugControl5::OutputContextStackTraceEx method (dbgeng.h)

  • Article

The OutputContextStackTraceEx method prints the call stack specified by an array of stack frames and corresponding register contexts. The OutputContextStackTraceEx method provides inline frame support. For more information about working with inline functions, see Debugging Optimized Code and Inline Functions.

Syntax

HRESULT OutputContextStackTraceEx(
  [in] ULONG                 OutputControl,
  [in] PDEBUG_STACK_FRAME_EX Frames,
  [in] ULONG                 FramesSize,
  [in] PVOID                 FrameContexts,
  [in] ULONG                 FrameContextsSize,
  [in] ULONG                 FrameContextsEntrySize,
  [in] ULONG                 Flags
);

Parameters

[in] OutputControl

Specifies where to send the output. For possible values, see DEBUG_OUTCTL_XXX.

[in] Frames

Specifies the array of stack frames to output. The number of elements in this array is FramesSize. If Frames is NULL, the current stack frame is used.

[in] FramesSize

Specifies the number of frames to output.

[in] FrameContexts

Specifies the register context for each frame in the stack. The entries in this array correspond to the entries in the Frames array. The type of the thread context is the CONTEXT structure for the target's effective processor.

[in] FrameContextsSize

Specifies the size, in bytes, of the memory pointed to by FrameContexts. The number of stack frames must equal the number of contexts, and FrameContextsSize must equal FramesSize multiplied by FrameContextsEntrySize.

[in] FrameContextsEntrySize

Specifies the size, in bytes, of each frame context in FrameContexts.

[in] Flags

Specifies bit flags that determine what information to output for each frame. Flags can be any combination of values from the following table.

Flag Description
DEBUG_STACK_ARGUMENTS Displays the first three pieces of stack memory at the frame of each call. On platforms where arguments are passed on the stack, and the code for the frame uses stack arguments, these values will be the arguments to the function.
DEBUG_STACK_FUNCTION_INFO Displays information about the function that corresponds to the frame. This includes calling convention and frame pointer omission (FPO) information.
DEBUG_STACK_SOURCE_LINE Displays source line information for each frame of the stack trace.
DEBUG_STACK_FRAME_ADDRESSES Displays the return address, previous frame address, and other relevant addresses for each frame.
DEBUG_STACK_COLUMN_NAMES Displays column names.
DEBUG_STACK_NONVOLATILE_REGISTERS Displays the non-volatile register context for each frame. This is only meaningful for some platforms.
DEBUG_STACK_FRAME_NUMBERS Displays frame numbers.
DEBUG_STACK_PARAMETERS Displays parameter names and values as given in symbol information.
DEBUG_STACK_FRAME_ADDRESSES_RA_ONLY Displays just the return address in the stack frame addresses.
DEBUG_STACK_FRAME_MEMORY_USAGE Displays the number of bytes that separate the frames.
DEBUG_STACK_PARAMETERS_NEWLINE Displays each parameter and its type and value on a new line.

Return value

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

Return code Description
S_OK
 The method was successful.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h

See also

IDebugControl5