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

SymGetSourceFileFromTokenByTokenNameW

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

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetSourceFileFromTokenByTokenNameW(
    HANDLE hProcess,
    void* Token,
    LPCWSTR TokenName,   // optional
    LPCWSTR Params,   // optional
    LPWSTR FilePath,
    DWORD Size
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymGetSourceFileFromTokenByTokenNameW(
    HANDLE hProcess,
    void* Token,
    LPCWSTR TokenName,   // optional
    LPCWSTR Params,   // optional
    LPWSTR FilePath,
    DWORD Size
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SymGetSourceFileFromTokenByTokenNameW(
    IntPtr hProcess,   // HANDLE
    IntPtr Token,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string TokenName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string Params,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder FilePath,   // LPWSTR out
    uint Size   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SymGetSourceFileFromTokenByTokenNameW(
    hProcess As IntPtr,   ' HANDLE
    Token As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> TokenName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> Params As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> FilePath As System.Text.StringBuilder,   ' LPWSTR out
    Size As UInteger   ' DWORD
) As Boolean
End Function
' hProcess : HANDLE
' Token : void*
' TokenName : LPCWSTR optional
' Params : LPCWSTR optional
' FilePath : LPWSTR out
' Size : DWORD
Declare PtrSafe Function SymGetSourceFileFromTokenByTokenNameW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Token As LongPtr, _
    ByVal TokenName As LongPtr, _
    ByVal Params As LongPtr, _
    ByVal FilePath As LongPtr, _
    ByVal Size As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymGetSourceFileFromTokenByTokenNameW = dbghelp.NewProc("SymGetSourceFileFromTokenByTokenNameW")
)

// hProcess (HANDLE), Token (void*), TokenName (LPCWSTR optional), Params (LPCWSTR optional), FilePath (LPWSTR out), Size (DWORD)
r1, _, err := procSymGetSourceFileFromTokenByTokenNameW.Call(
	uintptr(hProcess),
	uintptr(Token),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TokenName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Params))),
	uintptr(FilePath),
	uintptr(Size),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymGetSourceFileFromTokenByTokenNameW(
  hProcess: THandle;   // HANDLE
  Token: Pointer;   // void*
  TokenName: PWideChar;   // LPCWSTR optional
  Params: PWideChar;   // LPCWSTR optional
  FilePath: PWideChar;   // LPWSTR out
  Size: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymGetSourceFileFromTokenByTokenNameW';
result := DllCall("dbghelp\SymGetSourceFileFromTokenByTokenNameW"
    , "Ptr", hProcess   ; HANDLE
    , "Ptr", Token   ; void*
    , "WStr", TokenName   ; LPCWSTR optional
    , "WStr", Params   ; LPCWSTR optional
    , "Ptr", FilePath   ; LPWSTR out
    , "UInt", Size   ; DWORD
    , "Int")   ; return: BOOL
●SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size) = DLL("dbghelp.dll", "bool SymGetSourceFileFromTokenByTokenNameW(void*, void*, char*, char*, char*, dword)")
# 呼び出し: SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size)
# hProcess : HANDLE -> "void*"
# Token : void* -> "void*"
# TokenName : LPCWSTR optional -> "char*"
# Params : LPCWSTR optional -> "char*"
# FilePath : LPWSTR out -> "char*"
# Size : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。