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

SymEnumerateSymbols64

関数
モジュール内のシンボルを列挙する(旧式API)。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymEnumerateSymbols64(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    PSYM_ENUMSYMBOLS_CALLBACK64 EnumSymbolsCallback,
    void* UserContext   // optional
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDllULONGLONGinシンボルを列挙する対象モジュールのベースアドレス。
EnumSymbolsCallbackPSYM_ENUMSYMBOLS_CALLBACK64inシンボル情報を受け取るコールバック関数。詳細については、 SymEnumerateSymbolsProc64 を参照してください。
UserContextvoid*inoptionalユーザー定義の値、または NULL。この値はコールバック関数に渡されます。通常、このパラメーターは、コールバック関数が何らかのコンテキストを確立できるように、アプリケーションがデータ構造へのポインターを渡す目的で使用されます。

戻り値の型: BOOL

公式ドキュメント

指定したモジュールのすべてのシンボルを列挙します。(SymEnumerateSymbols64)

戻り値

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

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

解説(Remarks)

SymEnumerateSymbols64 関数は、指定したモジュールのすべてのシンボルを列挙します。モジュール情報は BaseOfDll パラメーターによって特定されます。コールバック関数はシンボルごとに 1 回呼び出され、各シンボルの情報が渡されます。

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

この関数の Unicode バージョンである SymEnumerateSymbolsW64 は、Dbghelp.h で次のように定義されています。


BOOL
IMAGEAPI
SymEnumerateSymbolsW64(
    __in HANDLE hProcess,
    __in ULONG64 BaseOfDll,
    __in PSYM_ENUMSYMBOLS_CALLBACK64W EnumSymbolsCallback,
    __in_opt PVOID UserContext
    );

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymEnumerateSymbols SymEnumerateSymbols64
#define SymEnumerateSymbolsW SymEnumerateSymbolsW64
#else
BOOL
IMAGEAPI
SymEnumerateSymbols(
    __in HANDLE hProcess,
    __in ULONG BaseOfDll,
    __in PSYM_ENUMSYMBOLS_CALLBACK EnumSymbolsCallback,
    __in_opt PVOID UserContext
    );

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

各言語での呼び出し定義

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

BOOL SymEnumerateSymbols64(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    PSYM_ENUMSYMBOLS_CALLBACK64 EnumSymbolsCallback,
    void* UserContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymEnumerateSymbols64(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    IntPtr EnumSymbolsCallback,   // PSYM_ENUMSYMBOLS_CALLBACK64
    IntPtr UserContext   // void* optional
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymEnumerateSymbols64(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    EnumSymbolsCallback As IntPtr,   ' PSYM_ENUMSYMBOLS_CALLBACK64
    UserContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64
' UserContext : void* optional
Declare PtrSafe Function SymEnumerateSymbols64 Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal EnumSymbolsCallback 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

SymEnumerateSymbols64 = ctypes.windll.dbghelp.SymEnumerateSymbols64
SymEnumerateSymbols64.restype = wintypes.BOOL
SymEnumerateSymbols64.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    ctypes.c_void_p,  # EnumSymbolsCallback : PSYM_ENUMSYMBOLS_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')
SymEnumerateSymbols64 = Fiddle::Function.new(
  lib['SymEnumerateSymbols64'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    Fiddle::TYPE_VOIDP,  # EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64
    Fiddle::TYPE_VOIDP,  # UserContext : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymEnumerateSymbols64(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        EnumSymbolsCallback: *const core::ffi::c_void,  // PSYM_ENUMSYMBOLS_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 SymEnumerateSymbols64(IntPtr hProcess, ulong BaseOfDll, IntPtr EnumSymbolsCallback, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymEnumerateSymbols64' -Namespace Win32 -PassThru
# $api::SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
#uselib "dbghelp.dll"
#func global SymEnumerateSymbols64 "SymEnumerateSymbols64" sptr, sptr, sptr, sptr
; SymEnumerateSymbols64 hProcess, BaseOfDll, EnumSymbolsCallback, UserContext   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "sptr"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> "sptr"
; UserContext : void* optional -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymEnumerateSymbols64 "SymEnumerateSymbols64" sptr, int64, sptr, sptr
; res = SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> "sptr"
; UserContext : void* optional -> "sptr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOL SymEnumerateSymbols64(HANDLE hProcess, ULONGLONG BaseOfDll, PSYM_ENUMSYMBOLS_CALLBACK64 EnumSymbolsCallback, void* UserContext)
#uselib "dbghelp.dll"
#cfunc global SymEnumerateSymbols64 "SymEnumerateSymbols64" intptr, int64, intptr, intptr
; res = SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : ULONGLONG -> "int64"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> "intptr"
; UserContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumerateSymbols64 = dbghelp.NewProc("SymEnumerateSymbols64")
)

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

extern "dbghelp" fn SymEnumerateSymbols64(
    hProcess: ?*anyopaque, // HANDLE
    BaseOfDll: u64, // ULONGLONG
    EnumSymbolsCallback: ?*anyopaque, // PSYM_ENUMSYMBOLS_CALLBACK64
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc SymEnumerateSymbols64(
    hProcess: pointer,  # HANDLE
    BaseOfDll: uint64,  # ULONGLONG
    EnumSymbolsCallback: pointer,  # PSYM_ENUMSYMBOLS_CALLBACK64
    UserContext: pointer  # void* optional
): int32 {.importc: "SymEnumerateSymbols64", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymEnumerateSymbols64(
    void* hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    void* EnumSymbolsCallback,   // PSYM_ENUMSYMBOLS_CALLBACK64
    void* UserContext   // void* optional
);
ccall((:SymEnumerateSymbols64, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# BaseOfDll : ULONGLONG -> UInt64
# EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> Ptr{Cvoid}
# UserContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymEnumerateSymbols64(
    void* hProcess,
    uint64_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
-- hProcess : HANDLE
-- BaseOfDll : ULONGLONG
-- EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64
-- UserContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymEnumerateSymbols64 = lib.func('__stdcall', 'SymEnumerateSymbols64', 'int32_t', ['void *', 'uint64_t', 'void *', 'void *']);
// SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> 'void *'
// BaseOfDll : ULONGLONG -> 'uint64_t'
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymEnumerateSymbols64: { parameters: ["pointer", "u64", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> "pointer"
// BaseOfDll : ULONGLONG -> "u64"
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> "pointer"
// UserContext : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymEnumerateSymbols64(
    void* hProcess,
    uint64_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymEnumerateSymbols64(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext);
// hProcess : HANDLE
// BaseOfDll : ULONGLONG
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_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 SymEnumerateSymbols64(
        Pointer hProcess,   // HANDLE
        long BaseOfDll,   // ULONGLONG
        Callback EnumSymbolsCallback,   // PSYM_ENUMSYMBOLS_CALLBACK64
        Pointer UserContext   // void* optional
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymEnumerateSymbols64 = SymEnumerateSymbols64(
    hProcess : Void*,   # HANDLE
    BaseOfDll : UInt64,   # ULONGLONG
    EnumSymbolsCallback : Void*,   # PSYM_ENUMSYMBOLS_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 SymEnumerateSymbols64Native = Int32 Function(Pointer<Void>, Uint64, Pointer<Void>, Pointer<Void>);
typedef SymEnumerateSymbols64Dart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final SymEnumerateSymbols64 = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumerateSymbols64Native, SymEnumerateSymbols64Dart>('SymEnumerateSymbols64');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : ULONGLONG -> Uint64
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumerateSymbols64(
  hProcess: THandle;   // HANDLE
  BaseOfDll: UInt64;   // ULONGLONG
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMSYMBOLS_CALLBACK64
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumerateSymbols64';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let symenumeratesymbols64 =
  foreign "SymEnumerateSymbols64"
    ((ptr void) @-> uint64_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* BaseOfDll : ULONGLONG -> uint64_t *)
(* EnumSymbolsCallback : PSYM_ENUMSYMBOLS_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 ("SymEnumerateSymbols64" sym-enumerate-symbols64 :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base-of-dll :uint64)   ; ULONGLONG
  (enum-symbols-callback :pointer)   ; PSYM_ENUMSYMBOLS_CALLBACK64
  (user-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymEnumerateSymbols64 = Win32::API::More->new('dbghelp',
    'BOOL SymEnumerateSymbols64(HANDLE hProcess, UINT64 BaseOfDll, LPVOID EnumSymbolsCallback, LPVOID UserContext)');
# my $ret = $SymEnumerateSymbols64->Call($hProcess, $BaseOfDll, $EnumSymbolsCallback, $UserContext);
# hProcess : HANDLE -> HANDLE
# BaseOfDll : ULONGLONG -> UINT64
# EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACK64 -> LPVOID
# UserContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

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