ホーム › System.Diagnostics.Debug › SymGetModuleInfo

SymGetModuleInfo

関数

指定アドレスを含むモジュールのシンボル情報を取得する。

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

シグネチャ

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

BOOL SymGetModuleInfo(
    HANDLE hProcess,
    DWORD dwAddr,
    IMAGEHLP_MODULE* ModuleInfo
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	元々 SymInitialize 関数に渡されたプロセスへのハンドルです。
dwAddr	DWORD	in	SymLoadModule64 関数によってロードされたモジュールのいずれかに含まれる仮想アドレスです。
ModuleInfo	IMAGEHLP_MODULE*	out	IMAGEHLP_MODULE64 構造体へのポインターです。SizeOfStruct メンバーには IMAGEHLP_MODULE64 構造体のサイズを設定する必要があります。無効な値を設定するとエラーになります。

戻り値の型: BOOL

公式ドキュメント

SymGetModuleInfo 関数 (dbghelp.h) は、指定されたモジュールのモジュール情報を取得します。

戻り値

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

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

解説(Remarks)

モジュールテーブルから、dwAddr を含むモジュールが検索されます。モジュールは、各モジュールのロードアドレスとサイズに基づいて特定されます。有効なモジュールが見つかった場合、ModuleInfo パラメーターにそのモジュールに関する情報が格納されます。

この関数で使用される IMAGEHLP_MODULE64 構造体のサイズは、長年にわたって変更されてきました。呼び出し側コードのコンパイルに使用した DbgHelp.h よりも古いバージョンの DbgHelp.dll が呼び出された場合、この関数はエラーコード ERROR_INVALID_PARAMETER で失敗することがあります。これは、システムバージョン (%WinDir%\System32\DbgHelp.dll) が呼び出された場合に最もよく発生します。システムバージョンの DbgHelp.dll を呼び出すコードは、その Windows リリースに対応する適切な SDK、またはそれ以前のリリースの SDK を使用してコンパイルする必要があります。

推奨されるモデルは、必要なバージョンの DbgHelp.dll を呼び出し側のソフトウェアとともに再配布することです。これにより、呼び出し側は最も堅牢なバージョンの DbgHelp.dll を使用でき、アップグレードも簡単になります。最新バージョンの DbgHelp.dll は、常に Debugging Tools for Windows パッケージから入手できます。一般的な原則として、古いバージョン向けにコンパイルされたコードは、常に新しいバージョンでも動作します。

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。SymGetModuleInfoW64 は DbgHelp.h で次のように定義されています。


BOOL
IMAGEAPI
SymGetModuleInfoW64(
    __in HANDLE hProcess,
    __in DWORD64 qwAddr,
    __out PIMAGEHLP_MODULEW64 ModuleInfo
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
#define SymGetModuleInfo64   SymGetModuleInfoW64
#endif

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetModuleInfo   SymGetModuleInfo64
#define SymGetModuleInfoW  SymGetModuleInfoW64
#else
BOOL
IMAGEAPI
SymGetModuleInfo(
    __in HANDLE hProcess,
    __in DWORD dwAddr,
    __out PIMAGEHLP_MODULE ModuleInfo
    );

BOOL
IMAGEAPI
SymGetModuleInfoW(
    __in HANDLE hProcess,
    __in DWORD dwAddr,
    __out PIMAGEHLP_MODULEW ModuleInfo
    );
#endif

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

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SymGetModuleInfo(
    IntPtr hProcess,   // HANDLE
    uint dwAddr,   // DWORD
    IntPtr ModuleInfo   // IMAGEHLP_MODULE* out
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymGetModuleInfo(
    hProcess As IntPtr,   ' HANDLE
    dwAddr As UInteger,   ' DWORD
    ModuleInfo As IntPtr   ' IMAGEHLP_MODULE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hProcess : HANDLE
' dwAddr : DWORD
' ModuleInfo : IMAGEHLP_MODULE* out
Declare PtrSafe Function SymGetModuleInfo Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal dwAddr As Long, _
    ByVal ModuleInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymGetModuleInfo = ctypes.windll.dbghelp.SymGetModuleInfo
SymGetModuleInfo.restype = wintypes.BOOL
SymGetModuleInfo.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # dwAddr : DWORD
    ctypes.c_void_p,  # ModuleInfo : IMAGEHLP_MODULE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymGetModuleInfo = Fiddle::Function.new(
  lib['SymGetModuleInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # dwAddr : DWORD
    Fiddle::TYPE_VOIDP,  # ModuleInfo : IMAGEHLP_MODULE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymGetModuleInfo(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        dwAddr: u32,  // DWORD
        ModuleInfo: *mut IMAGEHLP_MODULE  // IMAGEHLP_MODULE* 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 SymGetModuleInfo(IntPtr hProcess, uint dwAddr, IntPtr ModuleInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymGetModuleInfo' -Namespace Win32 -PassThru
# $api::SymGetModuleInfo(hProcess, dwAddr, ModuleInfo)

#uselib "dbghelp.dll"
#func global SymGetModuleInfo "SymGetModuleInfo" sptr, sptr, sptr
; SymGetModuleInfo hProcess, dwAddr, varptr(ModuleInfo)   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; dwAddr : DWORD -> "sptr"
; ModuleInfo : IMAGEHLP_MODULE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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