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

SymFromNameW

関数
シンボル名からシンボル情報を取得する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymFromNameW(
    HANDLE hProcess,
    LPCWSTR Name,
    SYMBOL_INFOW* Symbol
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
NameLPCWSTRin検索するシンボルの名前。
SymbolSYMBOL_INFOW*inoutシンボルに関する情報を提供する SYMBOL_INFO 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

SymFromNameW (Unicode) 関数は、指定された名前のシンボル情報を取得します。

戻り値

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

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

解説(Remarks)

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

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

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

メモ

dbghelp.h ヘッダーは SymFromName をエイリアスとして定義しており、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 SymFromNameW(
    HANDLE hProcess,
    LPCWSTR Name,
    SYMBOL_INFOW* Symbol
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymFromNameW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string Name,   // LPCWSTR
    IntPtr Symbol   // SYMBOL_INFOW* in/out
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymFromNameW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> Name As String,   ' LPCWSTR
    Symbol As IntPtr   ' SYMBOL_INFOW* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' Name : LPCWSTR
' Symbol : SYMBOL_INFOW* in/out
Declare PtrSafe Function SymFromNameW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal Name 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

SymFromNameW = ctypes.windll.dbghelp.SymFromNameW
SymFromNameW.restype = wintypes.BOOL
SymFromNameW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCWSTR,  # Name : LPCWSTR
    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')
SymFromNameW = Fiddle::Function.new(
  lib['SymFromNameW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # Name : LPCWSTR
    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 SymFromNameW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        Name: *const u16,  // LPCWSTR
        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 SymFromNameW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string Name, IntPtr Symbol);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFromNameW' -Namespace Win32 -PassThru
# $api::SymFromNameW(hProcess, Name, Symbol)
#uselib "dbghelp.dll"
#func global SymFromNameW "SymFromNameW" wptr, wptr, wptr
; SymFromNameW hProcess, Name, varptr(Symbol)   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; Name : LPCWSTR -> "wptr"
; Symbol : SYMBOL_INFOW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymFromNameW "SymFromNameW" sptr, wstr, var
; res = SymFromNameW(hProcess, Name, Symbol)
; hProcess : HANDLE -> "sptr"
; Name : LPCWSTR -> "wstr"
; Symbol : SYMBOL_INFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SymFromNameW(HANDLE hProcess, LPCWSTR Name, SYMBOL_INFOW* Symbol)
#uselib "dbghelp.dll"
#cfunc global SymFromNameW "SymFromNameW" intptr, wstr, var
; res = SymFromNameW(hProcess, Name, Symbol)
; hProcess : HANDLE -> "intptr"
; Name : LPCWSTR -> "wstr"
; Symbol : SYMBOL_INFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymFromNameW = dbghelp.NewProc("SymFromNameW")
)

// hProcess (HANDLE), Name (LPCWSTR), Symbol (SYMBOL_INFOW* in/out)
r1, _, err := procSymFromNameW.Call(
	uintptr(hProcess),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Name))),
	uintptr(Symbol),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymFromNameW(
  hProcess: THandle;   // HANDLE
  Name: PWideChar;   // LPCWSTR
  Symbol: Pointer   // SYMBOL_INFOW* in/out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymFromNameW';
result := DllCall("dbghelp\SymFromNameW"
    , "Ptr", hProcess   ; HANDLE
    , "WStr", Name   ; LPCWSTR
    , "Ptr", Symbol   ; SYMBOL_INFOW* in/out
    , "Int")   ; return: BOOL
●SymFromNameW(hProcess, Name, Symbol) = DLL("dbghelp.dll", "bool SymFromNameW(void*, char*, void*)")
# 呼び出し: SymFromNameW(hProcess, Name, Symbol)
# hProcess : HANDLE -> "void*"
# Name : LPCWSTR -> "char*"
# 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 SymFromNameW(
    hProcess: ?*anyopaque, // HANDLE
    Name: [*c]const u16, // LPCWSTR
    Symbol: [*c]SYMBOL_INFOW // SYMBOL_INFOW* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SymFromNameW(
    hProcess: pointer,  # HANDLE
    Name: WideCString,  # LPCWSTR
    Symbol: ptr SYMBOL_INFOW  # SYMBOL_INFOW* in/out
): int32 {.importc: "SymFromNameW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int SymFromNameW(
    void* hProcess,   // HANDLE
    const(wchar)* Name,   // LPCWSTR
    SYMBOL_INFOW* Symbol   // SYMBOL_INFOW* in/out
);
ccall((:SymFromNameW, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Ptr{SYMBOL_INFOW}),
      hProcess, Name, Symbol)
# hProcess : HANDLE -> Ptr{Cvoid}
# Name : LPCWSTR -> Cwstring
# 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 SymFromNameW(
    void* hProcess,
    const uint16_t* Name,
    void* Symbol);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymFromNameW(hProcess, Name, Symbol)
-- hProcess : HANDLE
-- Name : LPCWSTR
-- 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 SymFromNameW = lib.func('__stdcall', 'SymFromNameW', 'int32_t', ['void *', 'str16', 'void *']);
// SymFromNameW(hProcess, Name, Symbol)
// hProcess : HANDLE -> 'void *'
// Name : LPCWSTR -> 'str16'
// Symbol : SYMBOL_INFOW* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymFromNameW: { parameters: ["pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.SymFromNameW(hProcess, Name, Symbol)
// hProcess : HANDLE -> "pointer"
// Name : LPCWSTR -> "buffer"
// 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 SymFromNameW(
    void* hProcess,
    const uint16_t* Name,
    void* Symbol);
C, "dbghelp.dll");
// $ffi->SymFromNameW(hProcess, Name, Symbol);
// hProcess : HANDLE
// Name : LPCWSTR
// 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 SymFromNameW(
        Pointer hProcess,   // HANDLE
        WString Name,   // LPCWSTR
        Pointer Symbol   // SYMBOL_INFOW* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun SymFromNameW = SymFromNameW(
    hProcess : Void*,   # HANDLE
    Name : UInt16*,   # LPCWSTR
    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 SymFromNameWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
typedef SymFromNameWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>);
final SymFromNameW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymFromNameWNative, SymFromNameWDart>('SymFromNameW');
// hProcess : HANDLE -> Pointer<Void>
// Name : LPCWSTR -> Pointer<Utf16>
// Symbol : SYMBOL_INFOW* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymFromNameW(
  hProcess: THandle;   // HANDLE
  Name: PWideChar;   // LPCWSTR
  Symbol: Pointer   // SYMBOL_INFOW* in/out
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymFromNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymFromNameW"
  c_SymFromNameW :: Ptr () -> CWString -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- Name : LPCWSTR -> CWString
-- Symbol : SYMBOL_INFOW* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symfromnamew =
  foreign "SymFromNameW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* Name : LPCWSTR -> (ptr uint16_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 ("SymFromNameW" sym-from-name-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (name (:string :encoding :utf-16le))   ; LPCWSTR
  (symbol :pointer))   ; SYMBOL_INFOW* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymFromNameW = Win32::API::More->new('dbghelp',
    'BOOL SymFromNameW(HANDLE hProcess, LPCWSTR Name, LPVOID Symbol)');
# my $ret = $SymFromNameW->Call($hProcess, $Name, $Symbol);
# hProcess : HANDLE -> HANDLE
# Name : LPCWSTR -> LPCWSTR
# Symbol : SYMBOL_INFOW* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

使用する型