Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › RtlCaptureStackBackTrace

RtlCaptureStackBackTrace

関数
現在のスレッドの呼び出しスタックのトレースを取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

WORD RtlCaptureStackBackTrace(
    DWORD FramesToSkip,
    DWORD FramesToCapture,
    void** BackTrace,
    DWORD* BackTraceHash   // optional
);

パラメーター

名前方向
FramesToSkipDWORDin
FramesToCaptureDWORDin
BackTracevoid**out
BackTraceHashDWORD*outoptional

戻り値の型: WORD

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

WORD RtlCaptureStackBackTrace(
    DWORD FramesToSkip,
    DWORD FramesToCapture,
    void** BackTrace,
    DWORD* BackTraceHash   // optional
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern ushort RtlCaptureStackBackTrace(
    uint FramesToSkip,   // DWORD
    uint FramesToCapture,   // DWORD
    IntPtr BackTrace,   // void** out
    IntPtr BackTraceHash   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function RtlCaptureStackBackTrace(
    FramesToSkip As UInteger,   ' DWORD
    FramesToCapture As UInteger,   ' DWORD
    BackTrace As IntPtr,   ' void** out
    BackTraceHash As IntPtr   ' DWORD* optional, out
) As UShort
End Function
' FramesToSkip : DWORD
' FramesToCapture : DWORD
' BackTrace : void** out
' BackTraceHash : DWORD* optional, out
Declare PtrSafe Function RtlCaptureStackBackTrace Lib "kernel32" ( _
    ByVal FramesToSkip As Long, _
    ByVal FramesToCapture As Long, _
    ByVal BackTrace As LongPtr, _
    ByVal BackTraceHash As LongPtr) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtlCaptureStackBackTrace = ctypes.windll.kernel32.RtlCaptureStackBackTrace
RtlCaptureStackBackTrace.restype = ctypes.c_ushort
RtlCaptureStackBackTrace.argtypes = [
    wintypes.DWORD,  # FramesToSkip : DWORD
    wintypes.DWORD,  # FramesToCapture : DWORD
    ctypes.c_void_p,  # BackTrace : void** out
    ctypes.POINTER(wintypes.DWORD),  # BackTraceHash : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
RtlCaptureStackBackTrace = Fiddle::Function.new(
  lib['RtlCaptureStackBackTrace'],
  [
    -Fiddle::TYPE_INT,  # FramesToSkip : DWORD
    -Fiddle::TYPE_INT,  # FramesToCapture : DWORD
    Fiddle::TYPE_VOIDP,  # BackTrace : void** out
    Fiddle::TYPE_VOIDP,  # BackTraceHash : DWORD* optional, out
  ],
  -Fiddle::TYPE_SHORT)
#[link(name = "kernel32")]
extern "system" {
    fn RtlCaptureStackBackTrace(
        FramesToSkip: u32,  // DWORD
        FramesToCapture: u32,  // DWORD
        BackTrace: *mut *mut (),  // void** out
        BackTraceHash: *mut u32  // DWORD* optional, out
    ) -> u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern ushort RtlCaptureStackBackTrace(uint FramesToSkip, uint FramesToCapture, IntPtr BackTrace, IntPtr BackTraceHash);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_RtlCaptureStackBackTrace' -Namespace Win32 -PassThru
# $api::RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
#uselib "KERNEL32.dll"
#func global RtlCaptureStackBackTrace "RtlCaptureStackBackTrace" sptr, sptr, sptr, sptr
; RtlCaptureStackBackTrace FramesToSkip, FramesToCapture, BackTrace, varptr(BackTraceHash)   ; 戻り値は stat
; FramesToSkip : DWORD -> "sptr"
; FramesToCapture : DWORD -> "sptr"
; BackTrace : void** out -> "sptr"
; BackTraceHash : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global RtlCaptureStackBackTrace "RtlCaptureStackBackTrace" int, int, sptr, var
; res = RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
; FramesToSkip : DWORD -> "int"
; FramesToCapture : DWORD -> "int"
; BackTrace : void** out -> "sptr"
; BackTraceHash : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WORD RtlCaptureStackBackTrace(DWORD FramesToSkip, DWORD FramesToCapture, void** BackTrace, DWORD* BackTraceHash)
#uselib "KERNEL32.dll"
#cfunc global RtlCaptureStackBackTrace "RtlCaptureStackBackTrace" int, int, intptr, var
; res = RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
; FramesToSkip : DWORD -> "int"
; FramesToCapture : DWORD -> "int"
; BackTrace : void** out -> "intptr"
; BackTraceHash : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procRtlCaptureStackBackTrace = kernel32.NewProc("RtlCaptureStackBackTrace")
)

// FramesToSkip (DWORD), FramesToCapture (DWORD), BackTrace (void** out), BackTraceHash (DWORD* optional, out)
r1, _, err := procRtlCaptureStackBackTrace.Call(
	uintptr(FramesToSkip),
	uintptr(FramesToCapture),
	uintptr(BackTrace),
	uintptr(BackTraceHash),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WORD
function RtlCaptureStackBackTrace(
  FramesToSkip: DWORD;   // DWORD
  FramesToCapture: DWORD;   // DWORD
  BackTrace: Pointer;   // void** out
  BackTraceHash: Pointer   // DWORD* optional, out
): Word; stdcall;
  external 'KERNEL32.dll' name 'RtlCaptureStackBackTrace';
result := DllCall("KERNEL32\RtlCaptureStackBackTrace"
    , "UInt", FramesToSkip   ; DWORD
    , "UInt", FramesToCapture   ; DWORD
    , "Ptr", BackTrace   ; void** out
    , "Ptr", BackTraceHash   ; DWORD* optional, out
    , "UShort")   ; return: WORD
●RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash) = DLL("KERNEL32.dll", "int RtlCaptureStackBackTrace(dword, dword, void*, void*)")
# 呼び出し: RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
# FramesToSkip : DWORD -> "dword"
# FramesToCapture : DWORD -> "dword"
# BackTrace : void** out -> "void*"
# BackTraceHash : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。