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

SymEnumerateSymbolsW

関数
モジュール内のシンボルを列挙する(旧式Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymEnumerateSymbolsW(
    HANDLE hProcess,
    DWORD BaseOfDll,
    PSYM_ENUMSYMBOLS_CALLBACKW EnumSymbolsCallback,
    void* UserContext   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

SymEnumerateSymbolsW (Unicode) 関数は、指定したモジュールのすべてのシンボルを列挙します。

戻り値

関数が成功した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

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

SymEnumerateSymbolsW = ctypes.windll.dbghelp.SymEnumerateSymbolsW
SymEnumerateSymbolsW.restype = wintypes.BOOL
SymEnumerateSymbolsW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.DWORD,  # BaseOfDll : DWORD
    ctypes.c_void_p,  # EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW
    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')
SymEnumerateSymbolsW = Fiddle::Function.new(
  lib['SymEnumerateSymbolsW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_INT,  # BaseOfDll : DWORD
    Fiddle::TYPE_VOIDP,  # EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW
    Fiddle::TYPE_VOIDP,  # UserContext : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymEnumerateSymbolsW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u32,  // DWORD
        EnumSymbolsCallback: *const core::ffi::c_void,  // PSYM_ENUMSYMBOLS_CALLBACKW
        UserContext: *mut ()  // void* optional
    ) -> 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 SymEnumerateSymbolsW(IntPtr hProcess, uint BaseOfDll, IntPtr EnumSymbolsCallback, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymEnumerateSymbolsW' -Namespace Win32 -PassThru
# $api::SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
#uselib "dbghelp.dll"
#func global SymEnumerateSymbolsW "SymEnumerateSymbolsW" wptr, wptr, wptr, wptr
; SymEnumerateSymbolsW hProcess, BaseOfDll, EnumSymbolsCallback, UserContext   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; BaseOfDll : DWORD -> "wptr"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> "wptr"
; UserContext : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymEnumerateSymbolsW "SymEnumerateSymbolsW" sptr, int, sptr, sptr
; res = SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : DWORD -> "int"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> "sptr"
; UserContext : void* optional -> "sptr"
; BOOL SymEnumerateSymbolsW(HANDLE hProcess, DWORD BaseOfDll, PSYM_ENUMSYMBOLS_CALLBACKW EnumSymbolsCallback, void* UserContext)
#uselib "dbghelp.dll"
#cfunc global SymEnumerateSymbolsW "SymEnumerateSymbolsW" intptr, int, intptr, intptr
; res = SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : DWORD -> "int"
; EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> "intptr"
; UserContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumerateSymbolsW = dbghelp.NewProc("SymEnumerateSymbolsW")
)

// hProcess (HANDLE), BaseOfDll (DWORD), EnumSymbolsCallback (PSYM_ENUMSYMBOLS_CALLBACKW), UserContext (void* optional)
r1, _, err := procSymEnumerateSymbolsW.Call(
	uintptr(hProcess),
	uintptr(BaseOfDll),
	uintptr(EnumSymbolsCallback),
	uintptr(UserContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymEnumerateSymbolsW(
  hProcess: THandle;   // HANDLE
  BaseOfDll: DWORD;   // DWORD
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMSYMBOLS_CALLBACKW
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumerateSymbolsW';
result := DllCall("dbghelp\SymEnumerateSymbolsW"
    , "Ptr", hProcess   ; HANDLE
    , "UInt", BaseOfDll   ; DWORD
    , "Ptr", EnumSymbolsCallback   ; PSYM_ENUMSYMBOLS_CALLBACKW
    , "Ptr", UserContext   ; void* optional
    , "Int")   ; return: BOOL
●SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext) = DLL("dbghelp.dll", "bool SymEnumerateSymbolsW(void*, dword, void*, void*)")
# 呼び出し: SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> "void*"
# BaseOfDll : DWORD -> "dword"
# EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> "void*"
# UserContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "dbghelp" fn SymEnumerateSymbolsW(
    hProcess: ?*anyopaque, // HANDLE
    BaseOfDll: u32, // DWORD
    EnumSymbolsCallback: ?*anyopaque, // PSYM_ENUMSYMBOLS_CALLBACKW
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymEnumerateSymbolsW(
    hProcess: pointer,  # HANDLE
    BaseOfDll: uint32,  # DWORD
    EnumSymbolsCallback: pointer,  # PSYM_ENUMSYMBOLS_CALLBACKW
    UserContext: pointer  # void* optional
): int32 {.importc: "SymEnumerateSymbolsW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymEnumerateSymbolsW(
    void* hProcess,   // HANDLE
    uint BaseOfDll,   // DWORD
    void* EnumSymbolsCallback,   // PSYM_ENUMSYMBOLS_CALLBACKW
    void* UserContext   // void* optional
);
ccall((:SymEnumerateSymbolsW, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# BaseOfDll : DWORD -> UInt32
# EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> Ptr{Cvoid}
# UserContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymEnumerateSymbolsW(
    void* hProcess,
    uint32_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
-- hProcess : HANDLE
-- BaseOfDll : DWORD
-- EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW
-- UserContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymEnumerateSymbolsW = lib.func('__stdcall', 'SymEnumerateSymbolsW', 'int32_t', ['void *', 'uint32_t', 'void *', 'void *']);
// SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> 'void *'
// BaseOfDll : DWORD -> 'uint32_t'
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymEnumerateSymbolsW: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> "pointer"
// BaseOfDll : DWORD -> "u32"
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> "pointer"
// UserContext : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymEnumerateSymbolsW(
    void* hProcess,
    uint32_t BaseOfDll,
    void* EnumSymbolsCallback,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymEnumerateSymbolsW(hProcess, BaseOfDll, EnumSymbolsCallback, UserContext);
// hProcess : HANDLE
// BaseOfDll : DWORD
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW
// 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, W32APIOptions.UNICODE_OPTIONS);
    boolean SymEnumerateSymbolsW(
        Pointer hProcess,   // HANDLE
        int BaseOfDll,   // DWORD
        Callback EnumSymbolsCallback,   // PSYM_ENUMSYMBOLS_CALLBACKW
        Pointer UserContext   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymEnumerateSymbolsW = SymEnumerateSymbolsW(
    hProcess : Void*,   # HANDLE
    BaseOfDll : UInt32,   # DWORD
    EnumSymbolsCallback : Void*,   # PSYM_ENUMSYMBOLS_CALLBACKW
    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 SymEnumerateSymbolsWNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Void>);
typedef SymEnumerateSymbolsWDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final SymEnumerateSymbolsW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumerateSymbolsWNative, SymEnumerateSymbolsWDart>('SymEnumerateSymbolsW');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : DWORD -> Uint32
// EnumSymbolsCallback : PSYM_ENUMSYMBOLS_CALLBACKW -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumerateSymbolsW(
  hProcess: THandle;   // HANDLE
  BaseOfDll: DWORD;   // DWORD
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMSYMBOLS_CALLBACKW
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumerateSymbolsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

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