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

SymFromAddrW

関数
アドレスに対応するシンボル情報を取得する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymFromAddrW(
    HANDLE hProcess,
    ULONGLONG Address,
    ULONGLONG* Displacement,   // optional
    SYMBOL_INFOW* Symbol
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
AddressULONGLONGinシンボルを検索する対象のアドレス。このアドレスはシンボル境界上にある必要はありません。アドレスがシンボルの開始位置以降かつ終了位置より前にある場合、そのシンボルが見つかります。
DisplacementULONGLONG*outoptionalシンボルの開始位置からの変位、またはゼロ。
SymbolSYMBOL_INFOW*inoutシンボルに関する情報を提供する SYMBOL_INFO 構造体へのポインター。シンボル名は可変長であるため、このバッファーは SYMBOL_INFO 構造体の末尾に格納される名前を保持できるだけの十分な大きさが必要です。MaxNameLen メンバーには、名前のために予約したバイト数を必ず設定してください。

戻り値の型: BOOL

公式ドキュメント

SymFromAddrW (Unicode) 関数は、指定されたアドレスのシンボル情報を取得します。

戻り値

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

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

解説(Remarks)

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

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

Examples

例については、 Retrieving Symbol Information by Address を参照してください。

メモ

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

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

SymFromAddrW = ctypes.windll.dbghelp.SymFromAddrW
SymFromAddrW.restype = wintypes.BOOL
SymFromAddrW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # Address : ULONGLONG
    ctypes.POINTER(ctypes.c_ulonglong),  # Displacement : ULONGLONG* optional, out
    ctypes.c_void_p,  # Symbol : SYMBOL_INFOW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymFromAddrW = Fiddle::Function.new(
  lib['SymFromAddrW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # Address : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Displacement : ULONGLONG* optional, out
    Fiddle::TYPE_VOIDP,  # Symbol : SYMBOL_INFOW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymFromAddrW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Address: u64,  // ULONGLONG
        Displacement: *mut u64,  // ULONGLONG* optional, out
        Symbol: *mut SYMBOL_INFOW  // SYMBOL_INFOW* in/out
    ) -> 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 SymFromAddrW(IntPtr hProcess, ulong Address, IntPtr Displacement, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromAddrW' -Namespace Win32 -PassThru
# $api::SymFromAddrW(hProcess, Address, Displacement, Symbol)
#uselib "dbghelp.dll"
#func global SymFromAddrW "SymFromAddrW" wptr, wptr, wptr, wptr
; SymFromAddrW hProcess, Address, varptr(Displacement), varptr(Symbol)   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; Address : ULONGLONG -> "wptr"
; Displacement : ULONGLONG* optional, out -> "wptr"
; Symbol : SYMBOL_INFOW* in/out -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymFromAddrW "SymFromAddrW" sptr, int64, var, var
; res = SymFromAddrW(hProcess, Address, Displacement, Symbol)
; hProcess : HANDLE -> "sptr"
; Address : ULONGLONG -> "int64"
; Displacement : ULONGLONG* optional, out -> "var"
; Symbol : SYMBOL_INFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; BOOL SymFromAddrW(HANDLE hProcess, ULONGLONG Address, ULONGLONG* Displacement, SYMBOL_INFOW* Symbol)
#uselib "dbghelp.dll"
#cfunc global SymFromAddrW "SymFromAddrW" intptr, int64, var, var
; res = SymFromAddrW(hProcess, Address, Displacement, Symbol)
; hProcess : HANDLE -> "intptr"
; Address : ULONGLONG -> "int64"
; Displacement : ULONGLONG* optional, out -> "var"
; Symbol : SYMBOL_INFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymFromAddrW = dbghelp.NewProc("SymFromAddrW")
)

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

extern "dbghelp" fn SymFromAddrW(
    hProcess: ?*anyopaque, // HANDLE
    Address: u64, // ULONGLONG
    Displacement: [*c]u64, // ULONGLONG* optional, out
    Symbol: [*c]SYMBOL_INFOW // SYMBOL_INFOW* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymFromAddrW(
    hProcess: pointer,  # HANDLE
    Address: uint64,  # ULONGLONG
    Displacement: ptr uint64,  # ULONGLONG* optional, out
    Symbol: ptr SYMBOL_INFOW  # SYMBOL_INFOW* in/out
): int32 {.importc: "SymFromAddrW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymFromAddrW(
    void* hProcess,   // HANDLE
    ulong Address,   // ULONGLONG
    ulong* Displacement,   // ULONGLONG* optional, out
    SYMBOL_INFOW* Symbol   // SYMBOL_INFOW* in/out
);
ccall((:SymFromAddrW, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt64, Ptr{UInt64}, Ptr{SYMBOL_INFOW}),
      hProcess, Address, Displacement, Symbol)
# hProcess : HANDLE -> Ptr{Cvoid}
# Address : ULONGLONG -> UInt64
# Displacement : ULONGLONG* optional, out -> Ptr{UInt64}
# Symbol : SYMBOL_INFOW* in/out -> Ptr{SYMBOL_INFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymFromAddrW(
    void* hProcess,
    uint64_t Address,
    uint64_t* Displacement,
    void* Symbol);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymFromAddrW(hProcess, Address, Displacement, Symbol)
-- hProcess : HANDLE
-- Address : ULONGLONG
-- Displacement : ULONGLONG* optional, out
-- Symbol : SYMBOL_INFOW* in/out
-- 構造体/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 SymFromAddrW = lib.func('__stdcall', 'SymFromAddrW', 'int32_t', ['void *', 'uint64_t', 'uint64_t *', 'void *']);
// SymFromAddrW(hProcess, Address, Displacement, Symbol)
// hProcess : HANDLE -> 'void *'
// Address : ULONGLONG -> 'uint64_t'
// Displacement : ULONGLONG* optional, out -> 'uint64_t *'
// Symbol : SYMBOL_INFOW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymFromAddrW: { parameters: ["pointer", "u64", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymFromAddrW(hProcess, Address, Displacement, Symbol)
// hProcess : HANDLE -> "pointer"
// Address : ULONGLONG -> "u64"
// Displacement : ULONGLONG* optional, out -> "pointer"
// Symbol : SYMBOL_INFOW* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymFromAddrW(
    void* hProcess,
    uint64_t Address,
    uint64_t* Displacement,
    void* Symbol);
C, "dbghelp.dll");
// $ffi->SymFromAddrW(hProcess, Address, Displacement, Symbol);
// hProcess : HANDLE
// Address : ULONGLONG
// Displacement : ULONGLONG* optional, out
// Symbol : SYMBOL_INFOW* in/out
// 構造体/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 SymFromAddrW(
        Pointer hProcess,   // HANDLE
        long Address,   // ULONGLONG
        LongByReference Displacement,   // ULONGLONG* optional, out
        Pointer Symbol   // SYMBOL_INFOW* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymFromAddrW = SymFromAddrW(
    hProcess : Void*,   # HANDLE
    Address : UInt64,   # ULONGLONG
    Displacement : UInt64*,   # ULONGLONG* optional, out
    Symbol : SYMBOL_INFOW*   # SYMBOL_INFOW* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymFromAddrWNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Uint64>, Pointer<Void>);
typedef SymFromAddrWDart = int Function(Pointer<Void>, int, Pointer<Uint64>, Pointer<Void>);
final SymFromAddrW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymFromAddrWNative, SymFromAddrWDart>('SymFromAddrW');
// hProcess : HANDLE -> Pointer<Void>
// Address : ULONGLONG -> Uint64
// Displacement : ULONGLONG* optional, out -> Pointer<Uint64>
// Symbol : SYMBOL_INFOW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymFromAddrW(
  hProcess: THandle;   // HANDLE
  Address: UInt64;   // ULONGLONG
  Displacement: Pointer;   // ULONGLONG* optional, out
  Symbol: Pointer   // SYMBOL_INFOW* in/out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymFromAddrW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymFromAddrW"
  c_SymFromAddrW :: Ptr () -> Word64 -> Ptr Word64 -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Address : ULONGLONG -> Word64
-- Displacement : ULONGLONG* optional, out -> Ptr Word64
-- Symbol : SYMBOL_INFOW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symfromaddrw =
  foreign "SymFromAddrW"
    ((ptr void) @-> uint64_t @-> (ptr uint64_t) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Address : ULONGLONG -> uint64_t *)
(* Displacement : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* Symbol : SYMBOL_INFOW* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymFromAddrW" sym-from-addr-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (address :uint64)   ; ULONGLONG
  (displacement :pointer)   ; ULONGLONG* optional, out
  (symbol :pointer))   ; SYMBOL_INFOW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymFromAddrW = Win32::API::More->new('dbghelp',
    'BOOL SymFromAddrW(HANDLE hProcess, UINT64 Address, LPVOID Displacement, LPVOID Symbol)');
# my $ret = $SymFromAddrW->Call($hProcess, $Address, $Displacement, $Symbol);
# hProcess : HANDLE -> HANDLE
# Address : ULONGLONG -> UINT64
# Displacement : ULONGLONG* optional, out -> LPVOID
# Symbol : SYMBOL_INFOW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

使用する型