ホーム › System.Diagnostics.Debug › SymFromIndex

SymFromIndex

関数

インデックスからシンボル情報を取得する。

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

シグネチャ

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

BOOL SymFromIndex(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    DWORD Index,
    SYMBOL_INFO* Symbol
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDll	ULONGLONG	in	モジュールのベースアドレス。
Index	DWORD	in	シンボルを一意に識別する値。
Symbol	SYMBOL_INFO*	inout	シンボルに関する情報を提供する SYMBOL_INFO 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymFromIndex 関数 (dbghelp.h) は、指定されたインデックスに対応するシンボル情報を取得します。

戻り値

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

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

解説(Remarks)

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

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymFromIndex(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    uint Index,   // DWORD
    IntPtr Symbol   // SYMBOL_INFO* in/out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymFromIndex(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    Index As UInteger,   ' DWORD
    Symbol As IntPtr   ' SYMBOL_INFO* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' Index : DWORD
' Symbol : SYMBOL_INFO* in/out
Declare PtrSafe Function SymFromIndex Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal Index As Long, _
    ByVal Symbol As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymFromIndex = ctypes.windll.dbghelp.SymFromIndex
SymFromIndex.restype = wintypes.BOOL
SymFromIndex.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    wintypes.DWORD,  # Index : DWORD
    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')
SymFromIndex = Fiddle::Function.new(
  lib['SymFromIndex'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    -Fiddle::TYPE_INT,  # Index : DWORD
    Fiddle::TYPE_VOIDP,  # Symbol : SYMBOL_INFO* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymFromIndex(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        Index: u32,  // DWORD
        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 SymFromIndex(IntPtr hProcess, ulong BaseOfDll, uint Index, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromIndex' -Namespace Win32 -PassThru
# $api::SymFromIndex(hProcess, BaseOfDll, Index, Symbol)

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

出力引数:

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