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 <MarshalAs(UnmanagedType.Bool)> 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 版の利用を推奨。
const std = @import("std");

extern "dbghelp" fn SymGetSourceFileFromTokenByTokenNameW(
    hProcess: ?*anyopaque, // HANDLE
    Token: ?*anyopaque, // void*
    TokenName: [*c]const u16, // LPCWSTR optional
    Params: [*c]const u16, // LPCWSTR optional
    FilePath: [*c]u16, // LPWSTR out
    Size: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymGetSourceFileFromTokenByTokenNameW(
    hProcess: pointer,  # HANDLE
    Token: pointer,  # void*
    TokenName: WideCString,  # LPCWSTR optional
    Params: WideCString,  # LPCWSTR optional
    FilePath: ptr uint16,  # LPWSTR out
    Size: uint32  # DWORD
): int32 {.importc: "SymGetSourceFileFromTokenByTokenNameW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymGetSourceFileFromTokenByTokenNameW(
    void* hProcess,   // HANDLE
    void* Token,   // void*
    const(wchar)* TokenName,   // LPCWSTR optional
    const(wchar)* Params,   // LPCWSTR optional
    wchar* FilePath,   // LPWSTR out
    uint Size   // DWORD
);
ccall((:SymGetSourceFileFromTokenByTokenNameW, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Cwstring, Cwstring, Ptr{UInt16}, UInt32),
      hProcess, Token, TokenName, Params, FilePath, Size)
# hProcess : HANDLE -> Ptr{Cvoid}
# Token : void* -> Ptr{Cvoid}
# TokenName : LPCWSTR optional -> Cwstring
# Params : LPCWSTR optional -> Cwstring
# FilePath : LPWSTR out -> Ptr{UInt16}
# Size : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymGetSourceFileFromTokenByTokenNameW(
    void* hProcess,
    void* Token,
    const uint16_t* TokenName,
    const uint16_t* Params,
    uint16_t* FilePath,
    uint32_t Size);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size)
-- hProcess : HANDLE
-- Token : void*
-- TokenName : LPCWSTR optional
-- Params : LPCWSTR optional
-- FilePath : LPWSTR out
-- Size : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymGetSourceFileFromTokenByTokenNameW = lib.func('__stdcall', 'SymGetSourceFileFromTokenByTokenNameW', 'int32_t', ['void *', 'void *', 'str16', 'str16', 'uint16_t *', 'uint32_t']);
// SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size)
// hProcess : HANDLE -> 'void *'
// Token : void* -> 'void *'
// TokenName : LPCWSTR optional -> 'str16'
// Params : LPCWSTR optional -> 'str16'
// FilePath : LPWSTR out -> 'uint16_t *'
// Size : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymGetSourceFileFromTokenByTokenNameW: { parameters: ["pointer", "pointer", "buffer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size)
// hProcess : HANDLE -> "pointer"
// Token : void* -> "pointer"
// TokenName : LPCWSTR optional -> "buffer"
// Params : LPCWSTR optional -> "buffer"
// FilePath : LPWSTR out -> "buffer"
// Size : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymGetSourceFileFromTokenByTokenNameW(
    void* hProcess,
    void* Token,
    const uint16_t* TokenName,
    const uint16_t* Params,
    uint16_t* FilePath,
    uint32_t Size);
C, "dbghelp.dll");
// $ffi->SymGetSourceFileFromTokenByTokenNameW(hProcess, Token, TokenName, Params, FilePath, Size);
// hProcess : HANDLE
// Token : void*
// TokenName : LPCWSTR optional
// Params : LPCWSTR optional
// FilePath : LPWSTR 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.UNICODE_OPTIONS);
    boolean SymGetSourceFileFromTokenByTokenNameW(
        Pointer hProcess,   // HANDLE
        Pointer Token,   // void*
        WString TokenName,   // LPCWSTR optional
        WString Params,   // LPCWSTR optional
        char[] FilePath,   // LPWSTR out
        int Size   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymGetSourceFileFromTokenByTokenNameW = SymGetSourceFileFromTokenByTokenNameW(
    hProcess : Void*,   # HANDLE
    Token : Void*,   # void*
    TokenName : UInt16*,   # LPCWSTR optional
    Params : UInt16*,   # LPCWSTR optional
    FilePath : UInt16*,   # LPWSTR 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 SymGetSourceFileFromTokenByTokenNameWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef SymGetSourceFileFromTokenByTokenNameWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int);
final SymGetSourceFileFromTokenByTokenNameW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymGetSourceFileFromTokenByTokenNameWNative, SymGetSourceFileFromTokenByTokenNameWDart>('SymGetSourceFileFromTokenByTokenNameW');
// hProcess : HANDLE -> Pointer<Void>
// Token : void* -> Pointer<Void>
// TokenName : LPCWSTR optional -> Pointer<Utf16>
// Params : LPCWSTR optional -> Pointer<Utf16>
// FilePath : LPWSTR out -> Pointer<Utf16>
// Size : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let symgetsourcefilefromtokenbytokennamew =
  foreign "SymGetSourceFileFromTokenByTokenNameW"
    ((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Token : void* -> (ptr void) *)
(* TokenName : LPCWSTR optional -> (ptr uint16_t) *)
(* Params : LPCWSTR optional -> (ptr uint16_t) *)
(* FilePath : LPWSTR out -> (ptr uint16_t) *)
(* 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 ("SymGetSourceFileFromTokenByTokenNameW" sym-get-source-file-from-token-by-token-name-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (token :pointer)   ; void*
  (token-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (params (:string :encoding :utf-16le))   ; LPCWSTR optional
  (file-path :pointer)   ; LPWSTR out
  (size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymGetSourceFileFromTokenByTokenNameW = Win32::API::More->new('dbghelp',
    'BOOL SymGetSourceFileFromTokenByTokenNameW(HANDLE hProcess, LPVOID Token, LPCWSTR TokenName, LPCWSTR Params, LPWSTR FilePath, DWORD Size)');
# my $ret = $SymGetSourceFileFromTokenByTokenNameW->Call($hProcess, $Token, $TokenName, $Params, $FilePath, $Size);
# hProcess : HANDLE -> HANDLE
# Token : void* -> LPVOID
# TokenName : LPCWSTR optional -> LPCWSTR
# Params : LPCWSTR optional -> LPCWSTR
# FilePath : LPWSTR out -> LPWSTR
# Size : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。