Win32 API 日本語リファレンス
ホーム › System.Diagnostics.Debug › SymEnumerateModules64

SymEnumerateModules64

関数
プロセスに読み込まれたモジュールを列挙する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SymEnumerateModules64(
    HANDLE hProcess,
    PSYM_ENUMMODULES_CALLBACK64 EnumModulesCallback,
    void* UserContext   // optional
);

パラメーター

名前型方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスのハンドルです。
EnumModulesCallbackPSYM_ENUMMODULES_CALLBACK64in列挙コールバック関数です。この関数はモジュールごとに 1 回呼び出されます。詳細については、 SymEnumerateModulesProc64 を参照してください。
UserContextvoid*inoptionalユーザー定義の値、または NULL です。この値は単にコールバック関数へ渡されます。通常、このパラメーターは、コールバック関数が何らかのコンテキストを確立できるようにするためのデータ構造へのポインターをアプリケーションが渡す用途で使用されます。

戻り値の型: BOOL

公式ドキュメント

SymLoadModule64 関数または SymLoadModuleEx 関数によってプロセスに読み込まれたすべてのモジュールを列挙します。(SymEnumerateModules64)

戻り値

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

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

解説(Remarks)

SymEnumerateModules64 関数は、シンボルの読み込みが遅延されている場合でも、 SymLoadModule64 によってプロセスに読み込まれたすべてのモジュールを列挙します。列挙コールバック関数はモジュールごとに 1 回呼び出され、モジュール情報が渡されます。

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

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


BOOL
IMAGEAPI
SymEnumerateModulesW64(
    __in HANDLE hProcess,
    __in PSYM_ENUMMODULES_CALLBACKW64 EnumModulesCallback,
    __in_opt PVOID UserContext
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
#define SymEnumerateModules64  SymEnumerateModulesW64
#endif

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymEnumerateModules SymEnumerateModules64
#else
BOOL
IMAGEAPI
SymEnumerateModules(
    __in HANDLE hProcess,
    __in PSYM_ENUMMODULES_CALLBACK EnumModulesCallback,
    __in_opt PVOID UserContext
    );
#endif

例

例については、 Enumerating Symbol Modules を参照してください。

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

各言語での呼び出し定義

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

BOOL SymEnumerateModules64(
    HANDLE hProcess,
    PSYM_ENUMMODULES_CALLBACK64 EnumModulesCallback,
    void* UserContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymEnumerateModules64(
    IntPtr hProcess,   // HANDLE
    IntPtr EnumModulesCallback,   // PSYM_ENUMMODULES_CALLBACK64
    IntPtr UserContext   // void* optional
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymEnumerateModules64(
    hProcess As IntPtr,   ' HANDLE
    EnumModulesCallback As IntPtr,   ' PSYM_ENUMMODULES_CALLBACK64
    UserContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64
' UserContext : void* optional
Declare PtrSafe Function SymEnumerateModules64 Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal EnumModulesCallback As LongPtr, _
    ByVal UserContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymEnumerateModules64 = ctypes.windll.dbghelp.SymEnumerateModules64
SymEnumerateModules64.restype = wintypes.BOOL
SymEnumerateModules64.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_void_p,  # EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64
    ctypes.POINTER(None),  # UserContext : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymEnumerateModules64 = Fiddle::Function.new(
  lib['SymEnumerateModules64'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64
    Fiddle::TYPE_VOIDP,  # UserContext : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymEnumerateModules64(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        EnumModulesCallback: *const core::ffi::c_void,  // PSYM_ENUMMODULES_CALLBACK64
        UserContext: *mut ()  // void* optional
    ) -> 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 SymEnumerateModules64(IntPtr hProcess, IntPtr EnumModulesCallback, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymEnumerateModules64' -Namespace Win32 -PassThru
# $api::SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
#uselib "dbghelp.dll"
#func global SymEnumerateModules64 "SymEnumerateModules64" sptr, sptr, sptr
; SymEnumerateModules64 hProcess, EnumModulesCallback, UserContext   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> "sptr"
; UserContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymEnumerateModules64 "SymEnumerateModules64" sptr, sptr, sptr
; res = SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
; hProcess : HANDLE -> "sptr"
; EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> "sptr"
; UserContext : void* optional -> "sptr"
; BOOL SymEnumerateModules64(HANDLE hProcess, PSYM_ENUMMODULES_CALLBACK64 EnumModulesCallback, void* UserContext)
#uselib "dbghelp.dll"
#cfunc global SymEnumerateModules64 "SymEnumerateModules64" intptr, intptr, intptr
; res = SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
; hProcess : HANDLE -> "intptr"
; EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> "intptr"
; UserContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumerateModules64 = dbghelp.NewProc("SymEnumerateModules64")
)

// hProcess (HANDLE), EnumModulesCallback (PSYM_ENUMMODULES_CALLBACK64), UserContext (void* optional)
r1, _, err := procSymEnumerateModules64.Call(
	uintptr(hProcess),
	uintptr(EnumModulesCallback),
	uintptr(UserContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymEnumerateModules64(
  hProcess: THandle;   // HANDLE
  EnumModulesCallback: Pointer;   // PSYM_ENUMMODULES_CALLBACK64
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumerateModules64';
result := DllCall("dbghelp\SymEnumerateModules64"
    , "Ptr", hProcess   ; HANDLE
    , "Ptr", EnumModulesCallback   ; PSYM_ENUMMODULES_CALLBACK64
    , "Ptr", UserContext   ; void* optional
    , "Int")   ; return: BOOL
●SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext) = DLL("dbghelp.dll", "bool SymEnumerateModules64(void*, void*, void*)")
# 呼び出し: SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
# hProcess : HANDLE -> "void*"
# EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> "void*"
# UserContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymEnumerateModules64(
    hProcess: ?*anyopaque, // HANDLE
    EnumModulesCallback: ?*anyopaque, // PSYM_ENUMMODULES_CALLBACK64
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc SymEnumerateModules64(
    hProcess: pointer,  # HANDLE
    EnumModulesCallback: pointer,  # PSYM_ENUMMODULES_CALLBACK64
    UserContext: pointer  # void* optional
): int32 {.importc: "SymEnumerateModules64", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymEnumerateModules64(
    void* hProcess,   // HANDLE
    void* EnumModulesCallback,   // PSYM_ENUMMODULES_CALLBACK64
    void* UserContext   // void* optional
);
ccall((:SymEnumerateModules64, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, EnumModulesCallback, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> Ptr{Cvoid}
# UserContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymEnumerateModules64(
    void* hProcess,
    void* EnumModulesCallback,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
-- hProcess : HANDLE
-- EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64
-- UserContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymEnumerateModules64 = lib.func('__stdcall', 'SymEnumerateModules64', 'int32_t', ['void *', 'void *', 'void *']);
// SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
// hProcess : HANDLE -> 'void *'
// EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymEnumerateModules64: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext)
// hProcess : HANDLE -> "pointer"
// EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> "pointer"
// UserContext : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymEnumerateModules64(
    void* hProcess,
    void* EnumModulesCallback,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymEnumerateModules64(hProcess, EnumModulesCallback, UserContext);
// hProcess : HANDLE
// EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64
// UserContext : void* optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class);
    boolean SymEnumerateModules64(
        Pointer hProcess,   // HANDLE
        Callback EnumModulesCallback,   // PSYM_ENUMMODULES_CALLBACK64
        Pointer UserContext   // void* optional
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymEnumerateModules64 = SymEnumerateModules64(
    hProcess : Void*,   # HANDLE
    EnumModulesCallback : Void*,   # PSYM_ENUMMODULES_CALLBACK64
    UserContext : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymEnumerateModules64Native = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef SymEnumerateModules64Dart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final SymEnumerateModules64 = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumerateModules64Native, SymEnumerateModules64Dart>('SymEnumerateModules64');
// hProcess : HANDLE -> Pointer<Void>
// EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumerateModules64(
  hProcess: THandle;   // HANDLE
  EnumModulesCallback: Pointer;   // PSYM_ENUMMODULES_CALLBACK64
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumerateModules64';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymEnumerateModules64"
  c_SymEnumerateModules64 :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> Ptr ()
-- UserContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symenumeratemodules64 =
  foreign "SymEnumerateModules64"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> (ptr void) *)
(* UserContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymEnumerateModules64" sym-enumerate-modules64 :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (enum-modules-callback :pointer)   ; PSYM_ENUMMODULES_CALLBACK64
  (user-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymEnumerateModules64 = Win32::API::More->new('dbghelp',
    'BOOL SymEnumerateModules64(HANDLE hProcess, LPVOID EnumModulesCallback, LPVOID UserContext)');
# my $ret = $SymEnumerateModules64->Call($hProcess, $EnumModulesCallback, $UserContext);
# hProcess : HANDLE -> HANDLE
# EnumModulesCallback : PSYM_ENUMMODULES_CALLBACK64 -> LPVOID
# UserContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
公式の関連項目
使用する型