ホーム › System.Diagnostics.Debug › SymGetSourceFileToken

SymGetSourceFileToken

関数

ソースファイルを識別するトークンを取得する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymGetSourceFileToken(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR FileSpec,
    void** Token,
    DWORD* Size
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数へ渡されている必要があります。
Base	ULONGLONG	in	モジュールのベースアドレス。
FileSpec	LPCSTR	in	ソースファイルの名前。
Token	void**	out	トークンを受け取るバッファーへのポインター。
Size	DWORD*	out	Token バッファーのサイズ (バイト単位)。

戻り値の型: BOOL

公式ドキュメント

SymGetSourceFileToken 関数 (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 SymGetSourceFileToken(
    HANDLE hProcess,
    ULONGLONG Base,
    LPCSTR FileSpec,
    void** Token,
    DWORD* Size
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSourceFileToken(
    IntPtr hProcess,   // HANDLE
    ulong Base,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPStr)] string FileSpec,   // LPCSTR
    IntPtr Token,   // void** out
    out uint Size   // DWORD* out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSourceFileToken(
    hProcess As IntPtr,   ' HANDLE
    Base As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPStr)> FileSpec As String,   ' LPCSTR
    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
' Token : void** out
' Size : DWORD* out
Declare PtrSafe Function SymGetSourceFileToken Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Base As LongLong, _
    ByVal FileSpec 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

SymGetSourceFileToken = ctypes.windll.dbghelp.SymGetSourceFileToken
SymGetSourceFileToken.restype = wintypes.BOOL
SymGetSourceFileToken.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Base : ULONGLONG
    wintypes.LPCSTR,  # FileSpec : LPCSTR
    ctypes.c_void_p,  # Token : void** out
    ctypes.POINTER(wintypes.DWORD),  # Size : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSourceFileToken = Fiddle::Function.new(
  lib['SymGetSourceFileToken'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Base : ULONGLONG
    Fiddle::TYPE_VOIDP,  # FileSpec : LPCSTR
    Fiddle::TYPE_VOIDP,  # Token : void** out
    Fiddle::TYPE_VOIDP,  # Size : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSourceFileToken(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Base: u64,  // ULONGLONG
        FileSpec: *const u8,  // LPCSTR
        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, SetLastError = true)]
public static extern bool SymGetSourceFileToken(IntPtr hProcess, ulong Base, [MarshalAs(UnmanagedType.LPStr)] string FileSpec, IntPtr Token, out uint Size);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSourceFileToken' -Namespace Win32 -PassThru
# $api::SymGetSourceFileToken(hProcess, Base, FileSpec, Token, Size)

#uselib "dbghelp.dll"
#func global SymGetSourceFileToken "SymGetSourceFileToken" sptr, sptr, sptr, sptr, sptr
; SymGetSourceFileToken hProcess, Base, FileSpec, Token, varptr(Size)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "sptr"
; FileSpec : LPCSTR -> "sptr"
; Token : void** out -> "sptr"
; Size : DWORD* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileToken "SymGetSourceFileToken" sptr, int64, str, sptr, var
; res = SymGetSourceFileToken(hProcess, Base, FileSpec, Token, Size)
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCSTR -> "str"
; Token : void** out -> "sptr"
; Size : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "dbghelp.dll"
#cfunc global SymGetSourceFileToken "SymGetSourceFileToken" sptr, int64, str, sptr, sptr
; res = SymGetSourceFileToken(hProcess, Base, FileSpec, Token, varptr(Size))
; hProcess : HANDLE -> "sptr"
; Base : ULONGLONG -> "int64"
; FileSpec : LPCSTR -> "str"
; Token : void** out -> "sptr"
; Size : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。