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

SymEnumSymbolsForAddrW

関数
指定アドレスに関連するシンボルを列挙する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymEnumSymbolsForAddrW(
    HANDLE hProcess,
    ULONGLONG Address,
    PSYM_ENUMERATESYMBOLS_CALLBACKW EnumSymbolsCallback,
    void* UserContext   // optional
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
AddressULONGLONGinシンボルを検索する対象のアドレス。アドレスはシンボル境界上にある必要はありません。アドレスがシンボルの先頭以降、かつシンボルの末尾より前(シンボルの先頭にシンボルサイズを加えた位置)にある場合、この関数はそのシンボルを検出します。
EnumSymbolsCallbackPSYM_ENUMERATESYMBOLS_CALLBACKWinアプリケーション定義のコールバック関数。この関数は、Address で見つかったすべてのシンボルに対して呼び出されます。詳細については、 SymEnumSymbolsProc を参照してください。
UserContextvoid*inoptional省略可能なユーザー定義データ。この値はコールバック関数に渡されます。

戻り値の型: BOOL

公式ドキュメント

SymEnumSymbolsForAddrW (Unicode) 関数は、指定したアドレスのシンボルを列挙します。

戻り値

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

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

解説(Remarks)

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SymEnumSymbolsForAddrW(
    HANDLE hProcess,
    ULONGLONG Address,
    PSYM_ENUMERATESYMBOLS_CALLBACKW EnumSymbolsCallback,
    void* UserContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymEnumSymbolsForAddrW(
    IntPtr hProcess,   // HANDLE
    ulong Address,   // ULONGLONG
    IntPtr EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACKW
    IntPtr UserContext   // void* optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymEnumSymbolsForAddrW(
    hProcess As IntPtr,   ' HANDLE
    Address As ULong,   ' ULONGLONG
    EnumSymbolsCallback As IntPtr,   ' PSYM_ENUMERATESYMBOLS_CALLBACKW
    UserContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Address : ULONGLONG
' EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACKW
' UserContext : void* optional
Declare PtrSafe Function SymEnumSymbolsForAddrW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Address As LongLong, _
    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

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymEnumSymbolsForAddrW = dbghelp.NewProc("SymEnumSymbolsForAddrW")
)

// hProcess (HANDLE), Address (ULONGLONG), EnumSymbolsCallback (PSYM_ENUMERATESYMBOLS_CALLBACKW), UserContext (void* optional)
r1, _, err := procSymEnumSymbolsForAddrW.Call(
	uintptr(hProcess),
	uintptr(Address),
	uintptr(EnumSymbolsCallback),
	uintptr(UserContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymEnumSymbolsForAddrW(
  hProcess: THandle;   // HANDLE
  Address: UInt64;   // ULONGLONG
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMERATESYMBOLS_CALLBACKW
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumSymbolsForAddrW';
result := DllCall("dbghelp\SymEnumSymbolsForAddrW"
    , "Ptr", hProcess   ; HANDLE
    , "Int64", Address   ; ULONGLONG
    , "Ptr", EnumSymbolsCallback   ; PSYM_ENUMERATESYMBOLS_CALLBACKW
    , "Ptr", UserContext   ; void* optional
    , "Int")   ; return: BOOL
●SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext) = DLL("dbghelp.dll", "bool SymEnumSymbolsForAddrW(void*, qword, void*, void*)")
# 呼び出し: SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> "void*"
# Address : ULONGLONG -> "qword"
# EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrW(
    hProcess: ?*anyopaque, // HANDLE
    Address: u64, // ULONGLONG
    EnumSymbolsCallback: ?*anyopaque, // PSYM_ENUMERATESYMBOLS_CALLBACKW
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymEnumSymbolsForAddrW(
    hProcess: pointer,  # HANDLE
    Address: uint64,  # ULONGLONG
    EnumSymbolsCallback: pointer,  # PSYM_ENUMERATESYMBOLS_CALLBACKW
    UserContext: pointer  # void* optional
): int32 {.importc: "SymEnumSymbolsForAddrW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymEnumSymbolsForAddrW(
    void* hProcess,   // HANDLE
    ulong Address,   // ULONGLONG
    void* EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACKW
    void* UserContext   // void* optional
);
ccall((:SymEnumSymbolsForAddrW, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, Address, EnumSymbolsCallback, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# Address : ULONGLONG -> UInt64
# EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrW(
    void* hProcess,
    uint64_t Address,
    void* EnumSymbolsCallback,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext)
-- hProcess : HANDLE
-- Address : ULONGLONG
-- EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrW = lib.func('__stdcall', 'SymEnumSymbolsForAddrW', 'int32_t', ['void *', 'uint64_t', 'void *', 'void *']);
// SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> 'void *'
// Address : ULONGLONG -> 'uint64_t'
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACKW -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymEnumSymbolsForAddrW: { parameters: ["pointer", "u64", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext)
// hProcess : HANDLE -> "pointer"
// Address : ULONGLONG -> "u64"
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrW(
    void* hProcess,
    uint64_t Address,
    void* EnumSymbolsCallback,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymEnumSymbolsForAddrW(hProcess, Address, EnumSymbolsCallback, UserContext);
// hProcess : HANDLE
// Address : ULONGLONG
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrW(
        Pointer hProcess,   // HANDLE
        long Address,   // ULONGLONG
        Callback EnumSymbolsCallback,   // PSYM_ENUMERATESYMBOLS_CALLBACKW
        Pointer UserContext   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymEnumSymbolsForAddrW = SymEnumSymbolsForAddrW(
    hProcess : Void*,   # HANDLE
    Address : UInt64,   # ULONGLONG
    EnumSymbolsCallback : Void*,   # PSYM_ENUMERATESYMBOLS_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 SymEnumSymbolsForAddrWNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Void>, Pointer<Void>);
typedef SymEnumSymbolsForAddrWDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Void>);
final SymEnumSymbolsForAddrW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymEnumSymbolsForAddrWNative, SymEnumSymbolsForAddrWDart>('SymEnumSymbolsForAddrW');
// hProcess : HANDLE -> Pointer<Void>
// Address : ULONGLONG -> Uint64
// EnumSymbolsCallback : PSYM_ENUMERATESYMBOLS_CALLBACKW -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymEnumSymbolsForAddrW(
  hProcess: THandle;   // HANDLE
  Address: UInt64;   // ULONGLONG
  EnumSymbolsCallback: Pointer;   // PSYM_ENUMERATESYMBOLS_CALLBACKW
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymEnumSymbolsForAddrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

使用する型