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

SymGetSourceFileTokenByTokenName

関数
トークン名を指定してソースファイルのトークンを取得する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

BOOL SymGetSourceFileTokenByTokenName(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR FileSpec,
    LPCSTR TokenName,
    LPCSTR TokenParameters,   // optional
    void** Token,
    DWORD* Size
);

パラメーター

名前型方向説明
hProcessHANDLEinシンボルハンドラを初期化済みの対象プロセスのハンドル。
BaseULONGLONGin対象モジュールのベースアドレス。
FileSpecLPCSTRin対象ソースファイルの指定文字列。
TokenNameLPCSTRin取得するトークンの種類名を示す文字列。
TokenParametersLPCSTRinoptionalトークン取得に渡すパラメータ文字列。NULL可。
Tokenvoid**out取得されたトークンへのポインタを受け取る出力先。
SizeDWORD*outトークンのサイズ(バイト)を受け取る出力先。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SymGetSourceFileTokenByTokenName = ctypes.windll.dbghelp.SymGetSourceFileTokenByTokenName
SymGetSourceFileTokenByTokenName.restype = wintypes.BOOL
SymGetSourceFileTokenByTokenName.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCSTR,  # FileSpec : LPCSTR
    wintypes.LPCSTR,  # TokenName : LPCSTR
    wintypes.LPCSTR,  # TokenParameters : LPCSTR optional
    ctypes.c_void_p,  # Token : void** out
    ctypes.POINTER(wintypes.DWORD),  # Size : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceFileTokenByTokenName = dbghelp.NewProc("SymGetSourceFileTokenByTokenName")
)

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

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

typedef SymGetSourceFileTokenByTokenNameNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>);
typedef SymGetSourceFileTokenByTokenNameDart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Uint32>);
final SymGetSourceFileTokenByTokenName = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSourceFileTokenByTokenNameNative, SymGetSourceFileTokenByTokenNameDart>('SymGetSourceFileTokenByTokenName');
// hProcess : HANDLE -> Pointer<Void>
// Base : ULONGLONG -> Uint64
// FileSpec : LPCSTR -> Pointer<Utf8>
// TokenName : LPCSTR -> Pointer<Utf8>
// TokenParameters : LPCSTR optional -> Pointer<Utf8>
// Token : void** out -> Pointer<Void>
// Size : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymGetSourceFileTokenByTokenName(
  hProcess: THandle;   // HANDLE
  Base: UInt64;   // ULONGLONG
  FileSpec: PAnsiChar;   // LPCSTR
  TokenName: PAnsiChar;   // LPCSTR
  TokenParameters: PAnsiChar;   // LPCSTR optional
  Token: Pointer;   // void** out
  Size: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSourceFileTokenByTokenName';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymGetSourceFileTokenByTokenName"
  c_SymGetSourceFileTokenByTokenName :: Ptr () -> Word64 -> CString -> CString -> CString -> Ptr () -> Ptr Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Base : ULONGLONG -> Word64
-- FileSpec : LPCSTR -> CString
-- TokenName : LPCSTR -> CString
-- TokenParameters : LPCSTR optional -> CString
-- Token : void** out -> Ptr ()
-- Size : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symgetsourcefiletokenbytokenname =
  foreign "SymGetSourceFileTokenByTokenName"
    ((ptr void) @-> uint64_t @-> string @-> string @-> string @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Base : ULONGLONG -> uint64_t *)
(* FileSpec : LPCSTR -> string *)
(* TokenName : LPCSTR -> string *)
(* TokenParameters : LPCSTR optional -> string *)
(* Token : void** out -> (ptr void) *)
(* Size : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymGetSourceFileTokenByTokenName" sym-get-source-file-token-by-token-name :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base :uint64)   ; ULONGLONG
  (file-spec :string)   ; LPCSTR
  (token-name :string)   ; LPCSTR
  (token-parameters :string)   ; LPCSTR optional
  (token :pointer)   ; void** out
  (size :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSourceFileTokenByTokenName = Win32::API::More->new('dbghelp',
    'BOOL SymGetSourceFileTokenByTokenName(HANDLE hProcess, UINT64 Base, LPCSTR FileSpec, LPCSTR TokenName, LPCSTR TokenParameters, LPVOID Token, LPVOID Size)');
# my $ret = $SymGetSourceFileTokenByTokenName->Call($hProcess, $Base, $FileSpec, $TokenName, $TokenParameters, $Token, $Size);
# hProcess : HANDLE -> HANDLE
# Base : ULONGLONG -> UINT64
# FileSpec : LPCSTR -> LPCSTR
# TokenName : LPCSTR -> LPCSTR
# TokenParameters : LPCSTR optional -> LPCSTR
# Token : void** out -> LPVOID
# Size : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い