CaptureStackBackTrace function

Captures a stack back trace by walking up the stack and recording the information for each frame.

Syntax

USHORT WINAPI CaptureStackBackTrace(
  _In_      ULONG  FramesToSkip,
  _In_      ULONG  FramesToCapture,
  _Out_     PVOID  *BackTrace,
  _Out_opt_ PULONG BackTraceHash
);

Parameters

• FramesToSkip [in]
  The number of frames to skip from the start of the back trace.

• FramesToCapture [in]
  The number of frames to be captured. You can capture up to MAXUSHORT frames.

Windows Server 2003 and Windows XP: The sum of the FramesToSkip and FramesToCapture parameters must be less than 63.

• BackTrace [out]
  An array of pointers captured from the current stack trace.

• BackTraceHash [out, optional]
  A value that can be used to organize hash tables. If this parameter is NULL, then no hash value is computed.

  This value is calculated based on the values of the pointers returned in the BackTrace array. Two identical stack traces will generate identical hash values.

Return value

The number of captured frames.

Remarks

The CaptureStackBackTrace function is defined as the RtlCaptureStackBackTrace function (the definition is included in the Windows SDK beginning with Windows Vista). For more information, see WinBase.h and WinNT.h.

Requirements

Minimum supported client	Windows XP [desktop apps | UWP apps]
Minimum supported server	Windows Server 2003 [desktop apps | UWP apps]
Header	WinBase.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll