ホーム › System.Diagnostics.Debug › SymFromIndexW

SymFromIndexW

関数

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

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

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymFromIndexW(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    DWORD Index,
    SYMBOL_INFOW* Symbol
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

SymFromIndexW (Unicode) 関数は、指定されたインデックスのシンボル情報を取得します。

戻り値

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

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

解説(Remarks)

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

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SymFromIndex を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL SymFromIndexW(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    DWORD Index,
    SYMBOL_INFOW* Symbol
);

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

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

' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' Index : DWORD
' Symbol : SYMBOL_INFOW* in/out
Declare PtrSafe Function SymFromIndexW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal Index As Long, _
    ByVal Symbol As LongPtr) 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

SymFromIndexW = ctypes.windll.dbghelp.SymFromIndexW
SymFromIndexW.restype = wintypes.BOOL
SymFromIndexW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    wintypes.DWORD,  # Index : DWORD
    ctypes.c_void_p,  # Symbol : SYMBOL_INFOW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymFromIndexW = Fiddle::Function.new(
  lib['SymFromIndexW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    -Fiddle::TYPE_INT,  # Index : DWORD
    Fiddle::TYPE_VOIDP,  # Symbol : SYMBOL_INFOW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn SymFromIndexW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        Index: u32,  // DWORD
        Symbol: *mut SYMBOL_INFOW  // SYMBOL_INFOW* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SymFromIndexW(IntPtr hProcess, ulong BaseOfDll, uint Index, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromIndexW' -Namespace Win32 -PassThru
# $api::SymFromIndexW(hProcess, BaseOfDll, Index, Symbol)

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

出力引数:

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