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

SymFromToken

関数
トークンに対応するシンボル情報を取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymFromToken(
    HANDLE hProcess,
    ULONGLONG Base,
    DWORD Token,
    SYMBOL_INFO* Symbol
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseULONGLONGinマネージコードモジュールのベースアドレス。
TokenDWORDinマネージコードのトークン。
SymbolSYMBOL_INFO*inoutシンボルに関する情報を提供する SYMBOL_INFO 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymFromToken 関数 (dbghelp.h) は、指定されたマネージコードのトークンに対するシンボル情報を取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

この関数を含むすべての DbgHelp 関数はシングルスレッドです。そのため、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破壊が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymFromToken(
    HANDLE hProcess,
    ULONGLONG Base,
    DWORD Token,
    SYMBOL_INFO* Symbol
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymFromToken(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    uint Token,   // DWORD
    IntPtr Symbol   // SYMBOL_INFO* in/out
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymFromToken(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    Token As UInteger,   ' DWORD
    Symbol As IntPtr   ' SYMBOL_INFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Base : ULONGLONG
' Token : DWORD
' Symbol : SYMBOL_INFO* in/out
Declare PtrSafe Function SymFromToken Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal Token As Long, _
    ByVal Symbol As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymFromToken = ctypes.windll.dbghelp.SymFromToken
SymFromToken.restype = wintypes.BOOL
SymFromToken.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.DWORD,  # Token : DWORD
    ctypes.c_void_p,  # Symbol : SYMBOL_INFO* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymFromToken = Fiddle::Function.new(
  lib['SymFromToken'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    -Fiddle::TYPE_INT,  # Token : DWORD
    Fiddle::TYPE_VOIDP,  # Symbol : SYMBOL_INFO* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymFromToken(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        Token: u32,  // DWORD
        Symbol: *mut SYMBOL_INFO  // SYMBOL_INFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SymFromToken(IntPtr hProcess, ulong Base, uint Token, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromToken' -Namespace Win32 -PassThru
# $api::SymFromToken(hProcess, Base, Token, Symbol)
#uselib "dbghelp.dll"
#func global SymFromToken "SymFromToken" sptr, sptr, sptr, sptr
; SymFromToken hProcess, Base, Token, varptr(Symbol)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "sptr"
; Token : DWORD -> "sptr"
; Symbol : SYMBOL_INFO* in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymFromToken "SymFromToken" sptr, int64, int, var
; res = SymFromToken(hProcess, Base, Token, Symbol)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; Token : DWORD -> "int"
; Symbol : SYMBOL_INFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SymFromToken(HANDLE hProcess, ULONGLONG Base, DWORD Token, SYMBOL_INFO* Symbol)
#uselib "dbghelp.dll"
#cfunc global SymFromToken "SymFromToken" intptr, int64, int, var
; res = SymFromToken(hProcess, Base, Token, Symbol)
; hProcess : HANDLE -> "intptr"
; Base : ULONGLONG -> "int64"
; Token : DWORD -> "int"
; Symbol : SYMBOL_INFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymFromToken = dbghelp.NewProc("SymFromToken")
)

// hProcess (HANDLE), Base (ULONGLONG), Token (DWORD), Symbol (SYMBOL_INFO* in/out)
r1, _, err := procSymFromToken.Call(
	uintptr(hProcess),
	uintptr(Base),
	uintptr(Token),
	uintptr(Symbol),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymFromToken(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  Token: DWORD;   // DWORD
  Symbol: Pointer   // SYMBOL_INFO* in/out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymFromToken';
result := DllCall("dbghelp\SymFromToken"
    , "Ptr", hProcess   ; HANDLE
    , "Int64", Base   ; ULONGLONG
    , "UInt", Token   ; DWORD
    , "Ptr", Symbol   ; SYMBOL_INFO* in/out
    , "Int")   ; return: BOOL
●SymFromToken(hProcess, Base, Token, Symbol) = DLL("dbghelp.dll", "bool SymFromToken(void*, qword, dword, void*)")
# 呼び出し: SymFromToken(hProcess, Base, Token, Symbol)
# hProcess : HANDLE -> "void*"
# Base : ULONGLONG -> "qword"
# Token : DWORD -> "dword"
# Symbol : SYMBOL_INFO* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymFromToken(
    hProcess: ?*anyopaque, // HANDLE
    Base: u64, // ULONGLONG
    Token: u32, // DWORD
    Symbol: [*c]SYMBOL_INFO // SYMBOL_INFO* in/out
) callconv(std.os.windows.WINAPI) i32;
proc SymFromToken(
    hProcess: pointer,  # HANDLE
    Base: uint64,  # ULONGLONG
    Token: uint32,  # DWORD
    Symbol: ptr SYMBOL_INFO  # SYMBOL_INFO* in/out
): int32 {.importc: "SymFromToken", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymFromToken(
    void* hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    uint Token,   // DWORD
    SYMBOL_INFO* Symbol   // SYMBOL_INFO* in/out
);
ccall((:SymFromToken, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, UInt32, Ptr{SYMBOL_INFO}),
      hProcess, Base, Token, Symbol)
# hProcess : HANDLE -> Ptr{Cvoid}
# Base : ULONGLONG -> UInt64
# Token : DWORD -> UInt32
# Symbol : SYMBOL_INFO* in/out -> Ptr{SYMBOL_INFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymFromToken(
    void* hProcess,
    uint64_t Base,
    uint32_t Token,
    void* Symbol);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymFromToken(hProcess, Base, Token, Symbol)
-- hProcess : HANDLE
-- Base : ULONGLONG
-- Token : DWORD
-- Symbol : SYMBOL_INFO* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymFromToken = lib.func('__stdcall', 'SymFromToken', 'int32_t', ['void *', 'uint64_t', 'uint32_t', 'void *']);
// SymFromToken(hProcess, Base, Token, Symbol)
// hProcess : HANDLE -> 'void *'
// Base : ULONGLONG -> 'uint64_t'
// Token : DWORD -> 'uint32_t'
// Symbol : SYMBOL_INFO* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymFromToken: { parameters: ["pointer", "u64", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SymFromToken(hProcess, Base, Token, Symbol)
// hProcess : HANDLE -> "pointer"
// Base : ULONGLONG -> "u64"
// Token : DWORD -> "u32"
// Symbol : SYMBOL_INFO* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymFromToken(
    void* hProcess,
    uint64_t Base,
    uint32_t Token,
    void* Symbol);
C, "dbghelp.dll");
// $ffi->SymFromToken(hProcess, Base, Token, Symbol);
// hProcess : HANDLE
// Base : ULONGLONG
// Token : DWORD
// Symbol : SYMBOL_INFO* in/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 Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.ASCII_OPTIONS);
    boolean SymFromToken(
        Pointer hProcess,   // HANDLE
        long Base,   // ULONGLONG
        int Token,   // DWORD
        Pointer Symbol   // SYMBOL_INFO* in/out
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymFromToken = SymFromToken(
    hProcess : Void*,   # HANDLE
    Base : UInt64,   # ULONGLONG
    Token : UInt32,   # DWORD
    Symbol : SYMBOL_INFO*   # SYMBOL_INFO* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymFromTokenNative = Int32 Function(Pointer<Void>, Uint64, Uint32, Pointer<Void>);
typedef SymFromTokenDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final SymFromToken = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymFromTokenNative, SymFromTokenDart>('SymFromToken');
// hProcess : HANDLE -> Pointer<Void>
// Base : ULONGLONG -> Uint64
// Token : DWORD -> Uint32
// Symbol : SYMBOL_INFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymFromToken(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  Token: DWORD;   // DWORD
  Symbol: Pointer   // SYMBOL_INFO* in/out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymFromToken';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymFromToken"
  c_SymFromToken :: Ptr () -> Word64 -> Word32 -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Base : ULONGLONG -> Word64
-- Token : DWORD -> Word32
-- Symbol : SYMBOL_INFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symfromtoken =
  foreign "SymFromToken"
    ((ptr void) @-> uint64_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Base : ULONGLONG -> uint64_t *)
(* Token : DWORD -> uint32_t *)
(* Symbol : SYMBOL_INFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymFromToken" sym-from-token :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base :uint64)   ; ULONGLONG
  (token :uint32)   ; DWORD
  (symbol :pointer))   ; SYMBOL_INFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymFromToken = Win32::API::More->new('dbghelp',
    'BOOL SymFromToken(HANDLE hProcess, UINT64 Base, DWORD Token, LPVOID Symbol)');
# my $ret = $SymFromToken->Call($hProcess, $Base, $Token, $Symbol);
# hProcess : HANDLE -> HANDLE
# Base : ULONGLONG -> UINT64
# Token : DWORD -> DWORD
# Symbol : SYMBOL_INFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型