ホーム › System.Diagnostics.Debug › RtlCaptureStackBackTrace
RtlCaptureStackBackTrace
関数現在のスレッドの呼び出しスタックのトレースを取得する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
WORD RtlCaptureStackBackTrace(
DWORD FramesToSkip,
DWORD FramesToCapture,
void** BackTrace,
DWORD* BackTraceHash // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| FramesToSkip | DWORD | in | バックトレースの先頭からスキップするフレーム数。 |
| FramesToCapture | DWORD | in | キャプチャするフレーム数。 |
| BackTrace | void** | out | 現在のスタックトレースからキャプチャされたポインターの配列。 |
| BackTraceHash | DWORD* | outoptional | ハッシュテーブルを構成するために使用できる省略可能な値。このパラメーターが NULL の場合、ハッシュ値は計算されません。 この値は、BackTrace 配列で返されたポインターの値に基づいて計算されます。2 つの同一のスタックトレースは、同一のハッシュ値を生成します。 |
戻り値の型: WORD
公式ドキュメント
RtlCaptureStackBackTrace ルーチンは、スタックをさかのぼって走査し、各フレームの情報を記録することで、スタックのバックトレースをキャプチャします。
戻り値
キャプチャされたフレーム数。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// 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 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global RtlCaptureStackBackTrace "RtlCaptureStackBackTrace" int, int, sptr, sptr ; res = RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, varptr(BackTraceHash)) ; FramesToSkip : DWORD -> "int" ; FramesToCapture : DWORD -> "int" ; BackTrace : void** out -> "sptr" ; BackTraceHash : DWORD* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; WORD RtlCaptureStackBackTrace(DWORD FramesToSkip, DWORD FramesToCapture, void** BackTrace, DWORD* BackTraceHash) #uselib "KERNEL32.dll" #cfunc global RtlCaptureStackBackTrace "RtlCaptureStackBackTrace" int, int, intptr, intptr ; res = RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, varptr(BackTraceHash)) ; FramesToSkip : DWORD -> "int" ; FramesToCapture : DWORD -> "int" ; BackTrace : void** out -> "intptr" ; BackTraceHash : DWORD* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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 // WORDfunction 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)。const std = @import("std");
extern "kernel32" fn RtlCaptureStackBackTrace(
FramesToSkip: u32, // DWORD
FramesToCapture: u32, // DWORD
BackTrace: ?*anyopaque, // void** out
BackTraceHash: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u16;proc RtlCaptureStackBackTrace(
FramesToSkip: uint32, # DWORD
FramesToCapture: uint32, # DWORD
BackTrace: pointer, # void** out
BackTraceHash: ptr uint32 # DWORD* optional, out
): uint16 {.importc: "RtlCaptureStackBackTrace", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
ushort RtlCaptureStackBackTrace(
uint FramesToSkip, // DWORD
uint FramesToCapture, // DWORD
void** BackTrace, // void** out
uint* BackTraceHash // DWORD* optional, out
);ccall((:RtlCaptureStackBackTrace, "KERNEL32.dll"), stdcall, UInt16,
(UInt32, UInt32, Ptr{Cvoid}, Ptr{UInt32}),
FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
# FramesToSkip : DWORD -> UInt32
# FramesToCapture : DWORD -> UInt32
# BackTrace : void** out -> Ptr{Cvoid}
# BackTraceHash : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint16_t RtlCaptureStackBackTrace(
uint32_t FramesToSkip,
uint32_t FramesToCapture,
void** BackTrace,
uint32_t* BackTraceHash);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
-- FramesToSkip : DWORD
-- FramesToCapture : DWORD
-- BackTrace : void** out
-- BackTraceHash : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const RtlCaptureStackBackTrace = lib.func('__stdcall', 'RtlCaptureStackBackTrace', 'uint16_t', ['uint32_t', 'uint32_t', 'void *', 'uint32_t *']);
// RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
// FramesToSkip : DWORD -> 'uint32_t'
// FramesToCapture : DWORD -> 'uint32_t'
// BackTrace : void** out -> 'void *'
// BackTraceHash : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
RtlCaptureStackBackTrace: { parameters: ["u32", "u32", "pointer", "pointer"], result: "u16" },
});
// lib.symbols.RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash)
// FramesToSkip : DWORD -> "u32"
// FramesToCapture : DWORD -> "u32"
// BackTrace : void** out -> "pointer"
// BackTraceHash : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint16_t RtlCaptureStackBackTrace(
uint32_t FramesToSkip,
uint32_t FramesToCapture,
void** BackTrace,
uint32_t* BackTraceHash);
C, "KERNEL32.dll");
// $ffi->RtlCaptureStackBackTrace(FramesToSkip, FramesToCapture, BackTrace, BackTraceHash);
// FramesToSkip : DWORD
// FramesToCapture : DWORD
// BackTrace : void** out
// BackTraceHash : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
short RtlCaptureStackBackTrace(
int FramesToSkip, // DWORD
int FramesToCapture, // DWORD
Pointer BackTrace, // void** out
IntByReference BackTraceHash // DWORD* optional, out
);
}@[Link("kernel32")]
lib LibKERNEL32
fun RtlCaptureStackBackTrace = RtlCaptureStackBackTrace(
FramesToSkip : UInt32, # DWORD
FramesToCapture : UInt32, # DWORD
BackTrace : Void**, # void** out
BackTraceHash : UInt32* # DWORD* optional, out
) : UInt16
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RtlCaptureStackBackTraceNative = Uint16 Function(Uint32, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef RtlCaptureStackBackTraceDart = int Function(int, int, Pointer<Void>, Pointer<Uint32>);
final RtlCaptureStackBackTrace = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<RtlCaptureStackBackTraceNative, RtlCaptureStackBackTraceDart>('RtlCaptureStackBackTrace');
// FramesToSkip : DWORD -> Uint32
// FramesToCapture : DWORD -> Uint32
// BackTrace : void** out -> Pointer<Void>
// BackTraceHash : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RtlCaptureStackBackTrace(
FramesToSkip: DWORD; // DWORD
FramesToCapture: DWORD; // DWORD
BackTrace: Pointer; // void** out
BackTraceHash: Pointer // DWORD* optional, out
): Word; stdcall;
external 'KERNEL32.dll' name 'RtlCaptureStackBackTrace';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RtlCaptureStackBackTrace"
c_RtlCaptureStackBackTrace :: Word32 -> Word32 -> Ptr () -> Ptr Word32 -> IO Word16
-- FramesToSkip : DWORD -> Word32
-- FramesToCapture : DWORD -> Word32
-- BackTrace : void** out -> Ptr ()
-- BackTraceHash : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rtlcapturestackbacktrace =
foreign "RtlCaptureStackBackTrace"
(uint32_t @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning uint16_t)
(* FramesToSkip : DWORD -> uint32_t *)
(* FramesToCapture : DWORD -> uint32_t *)
(* BackTrace : void** out -> (ptr void) *)
(* BackTraceHash : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("RtlCaptureStackBackTrace" rtl-capture-stack-back-trace :convention :stdcall) :uint16
(frames-to-skip :uint32) ; DWORD
(frames-to-capture :uint32) ; DWORD
(back-trace :pointer) ; void** out
(back-trace-hash :pointer)) ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RtlCaptureStackBackTrace = Win32::API::More->new('KERNEL32',
'WORD RtlCaptureStackBackTrace(DWORD FramesToSkip, DWORD FramesToCapture, LPVOID BackTrace, LPVOID BackTraceHash)');
# my $ret = $RtlCaptureStackBackTrace->Call($FramesToSkip, $FramesToCapture, $BackTrace, $BackTraceHash);
# FramesToSkip : DWORD -> DWORD
# FramesToCapture : DWORD -> DWORD
# BackTrace : void** out -> LPVOID
# BackTraceHash : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。