ホーム › System.Diagnostics.Debug › SymFromName

SymFromName

関数

シンボル名からシンボル情報を取得する。

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

シグネチャ

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

BOOL SymFromName(
    HANDLE hProcess,
    LPCSTR Name,
    SYMBOL_INFO* Symbol
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
Name	LPCSTR	in	検索対象のシンボルの名前。
Symbol	SYMBOL_INFO*	inout	シンボルに関する情報を提供する SYMBOL_INFO 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymFromName 関数 (dbghelp.h) は、指定された名前のシンボル情報を取得します。

戻り値

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

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

解説(Remarks)

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

例

例については、 Retrieving Symbol Information by Name を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymFromName(
    HANDLE hProcess,
    LPCSTR Name,
    SYMBOL_INFO* Symbol
);

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

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

' hProcess : HANDLE
' Name : LPCSTR
' Symbol : SYMBOL_INFO* in/out
Declare PtrSafe Function SymFromName 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "dbghelp")]
extern "system" {
    fn SymFromName(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Name: *const u8,  // LPCSTR
        Symbol: *mut SYMBOL_INFO  // SYMBOL_INFO* in/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 SymFromName(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] string Name, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromName' -Namespace Win32 -PassThru
# $api::SymFromName(hProcess, Name, Symbol)

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

出力引数:

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