ホーム › System.Diagnostics.Debug › SymGetSymFromName64

SymGetSymFromName64

関数

シンボル名からシンボル情報を取得する(旧式API)。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll
#include <windows.h>

BOOL SymGetSymFromName64(
    HANDLE hProcess,
    LPCSTR Name,
    IMAGEHLP_SYMBOL64* Symbol
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	元々 SymInitialize 関数に渡されたプロセスのハンドル。
Name	LPCSTR	in	シンボルを検索する対象のシンボル名。
Symbol	IMAGEHLP_SYMBOL64*	inout	IMAGEHLP_SYMBOL64 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定された名前のシンボルを検索します。(SymGetSymFromName64)

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SymGetSymFromName64 関数は、指定された名前のシンボルを検索するために使用します。名前にはモジュールプレフィックスを含めることができ、これによりシンボル検索を単一モジュールのシンボルテーブルに限定できます。

モジュールプレフィックスは「module!」の形式です。「!」文字はモジュール名とシンボル名の区切り文字です。モジュールプレフィックスがない場合、最初に読み込まれたモジュールから順に、各モジュールのシンボルテーブルを線形に検索します。

モジュールプレフィックスの使用は、2 つの理由から望ましいものです。第 1 に、シンボル検索が大幅に高速化されます。第 2 に、遅延シンボル読み込みが有効な場合、検索対象となる各モジュールのシンボルが読み込まれてしまうためです。シンボルが見つかると、シンボル情報は呼び出し元が提供した Symbol バッファーにコピーされます。呼び出し元は、 SymGetSymFromName64 を呼び出す前に、Symbol バッファーを適切に割り当て、 IMAGEHLP_SYMBOL64 構造体に必要なパラメーターを設定する必要があります。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。したがって、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからこの関数への同時呼び出しをすべて同期する必要があります。

この関数は SymGetSymFromName 関数に取って代わるものです。詳細については、 Updated Platform Support を参照してください。SymGetSymFromName は Dbghelp.h で次のように定義されています。

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetSymFromName SymGetSymFromName64
#else
BOOL
IMAGEAPI
SymGetSymFromName(
    __in HANDLE hProcess,
    __in PCSTR Name,
    __inout PIMAGEHLP_SYMBOL Symbol
    );
#endif

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dbghelp.dll
#include <windows.h>

BOOL SymGetSymFromName64(
    HANDLE hProcess,
    LPCSTR Name,
    IMAGEHLP_SYMBOL64* Symbol
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymGetSymFromName64(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string Name,   // LPCSTR
    IntPtr Symbol   // IMAGEHLP_SYMBOL64* in/out
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetSymFromName64(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> Name As String,   ' LPCSTR
    Symbol As IntPtr   ' IMAGEHLP_SYMBOL64* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' Name : LPCSTR
' Symbol : IMAGEHLP_SYMBOL64* in/out
Declare PtrSafe Function SymGetSymFromName64 Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Name As String, _
    ByVal Symbol As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetSymFromName64 = ctypes.windll.dbghelp.SymGetSymFromName64
SymGetSymFromName64.restype = wintypes.BOOL
SymGetSymFromName64.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # Name : LPCSTR
    ctypes.c_void_p,  # Symbol : IMAGEHLP_SYMBOL64* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetSymFromName64 = Fiddle::Function.new(
  lib['SymGetSymFromName64'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # Name : LPCSTR
    Fiddle::TYPE_VOIDP,  # Symbol : IMAGEHLP_SYMBOL64* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetSymFromName64(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Name: *const u8,  // LPCSTR
        Symbol: *mut IMAGEHLP_SYMBOL64  // IMAGEHLP_SYMBOL64* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool SymGetSymFromName64(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string Name, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetSymFromName64' -Namespace Win32 -PassThru
# $api::SymGetSymFromName64(hProcess, Name, Symbol)

#uselib "dbghelp.dll"
#func global SymGetSymFromName64 "SymGetSymFromName64" sptr, sptr, sptr
; SymGetSymFromName64 hProcess, Name, varptr(Symbol)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; Name : LPCSTR -> "sptr"
; Symbol : IMAGEHLP_SYMBOL64* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global SymGetSymFromName64 "SymGetSymFromName64" sptr, str, var
; res = SymGetSymFromName64(hProcess, Name, Symbol)
; hProcess : HANDLE -> "sptr"
; Name : LPCSTR -> "str"
; Symbol : IMAGEHLP_SYMBOL64* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global SymGetSymFromName64 "SymGetSymFromName64" sptr, str, sptr
; res = SymGetSymFromName64(hProcess, Name, varptr(Symbol))
; hProcess : HANDLE -> "sptr"
; Name : LPCSTR -> "str"
; Symbol : IMAGEHLP_SYMBOL64* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。