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

SymGetSourceFileFromTokenByTokenName

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

シグネチャ

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

BOOL SymGetSourceFileFromTokenByTokenName(
    HANDLE hProcess,
    void* Token,
    LPCSTR TokenName,   // optional
    LPCSTR Params,   // optional
    LPSTR FilePath,
    DWORD Size
);

パラメーター

名前型方向説明
hProcessHANDLEinシンボルハンドラを初期化済みの対象プロセスのハンドル。
Tokenvoid*inソースファイルを特定するトークンへのポインタ。
TokenNameLPCSTRinoptionalトークンの種類名を示す文字列。
ParamsLPCSTRinoptionalソースサーバ用のパラメータ文字列。NULL可。
FilePathLPSTRout取得したローカルファイルパスを受け取るバッファ。
SizeDWORDinFilePathバッファのサイズ(バイト)。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SymGetSourceFileFromTokenByTokenName = ctypes.windll.dbghelp.SymGetSourceFileFromTokenByTokenName
SymGetSourceFileFromTokenByTokenName.restype = wintypes.BOOL
SymGetSourceFileFromTokenByTokenName.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # Token : void*
    wintypes.LPCSTR,  # TokenName : LPCSTR optional
    wintypes.LPCSTR,  # Params : LPCSTR optional
    wintypes.LPSTR,  # FilePath : LPSTR out
    wintypes.DWORD,  # Size : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSourceFileFromTokenByTokenName = Fiddle::Function.new(
  lib['SymGetSourceFileFromTokenByTokenName'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # Token : void*
    Fiddle::TYPE_VOIDP,  # TokenName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Params : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # FilePath : LPSTR out
    -Fiddle::TYPE_INT,  # Size : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceFileFromTokenByTokenName(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Token: *mut (),  // void*
        TokenName: *const u8,  // LPCSTR optional
        Params: *const u8,  // LPCSTR optional
        FilePath: *mut u8,  // LPSTR out
        Size: u32  // DWORD
    ) -> 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 SymGetSourceFileFromTokenByTokenName(IntPtr hProcess, IntPtr Token, [MarshalAs(UnmanagedType.LPStr)] string TokenName, [MarshalAs(UnmanagedType.LPStr)] string Params, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder FilePath, uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceFileFromTokenByTokenName' -Namespace Win32 -PassThru
# $api::SymGetSourceFileFromTokenByTokenName(hProcess, Token, TokenName, Params, FilePath, Size)
#uselib "dbghelp.dll"
#func global SymGetSourceFileFromTokenByTokenName "SymGetSourceFileFromTokenByTokenName" sptr, sptr, sptr, sptr, sptr, sptr
; SymGetSourceFileFromTokenByTokenName hProcess, Token, TokenName, Params, varptr(FilePath), Size   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Token : void* -> "sptr"
; TokenName : LPCSTR optional -> "sptr"
; Params : LPCSTR optional -> "sptr"
; FilePath : LPSTR out -> "sptr"
; Size : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileFromTokenByTokenName "SymGetSourceFileFromTokenByTokenName" sptr, sptr, str, str, var, int
; res = SymGetSourceFileFromTokenByTokenName(hProcess, Token, TokenName, Params, FilePath, Size)
; hProcess : HANDLE -> "sptr"
; Token : void* -> "sptr"
; TokenName : LPCSTR optional -> "str"
; Params : LPCSTR optional -> "str"
; FilePath : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL SymGetSourceFileFromTokenByTokenName(HANDLE hProcess, void* Token, LPCSTR TokenName, LPCSTR Params, LPSTR FilePath, DWORD Size)
#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileFromTokenByTokenName "SymGetSourceFileFromTokenByTokenName" intptr, intptr, str, str, var, int
; res = SymGetSourceFileFromTokenByTokenName(hProcess, Token, TokenName, Params, FilePath, Size)
; hProcess : HANDLE -> "intptr"
; Token : void* -> "intptr"
; TokenName : LPCSTR optional -> "str"
; Params : LPCSTR optional -> "str"
; FilePath : LPSTR out -> "var"
; Size : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceFileFromTokenByTokenName = dbghelp.NewProc("SymGetSourceFileFromTokenByTokenName")
)

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

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

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

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

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

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

関連項目

文字セット違い