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

SymAddSymbolW

関数
シンボルテーブルにユーザー定義シンボルを追加する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymAddSymbolW(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    LPCWSTR Name,
    ULONGLONG Address,
    DWORD Size,
    DWORD Flags
);

パラメーター

名前方向説明
hProcessHANDLEinプロセスへのハンドル。このハンドルは、事前に SymInitialize 関数に渡されている必要があります。
BaseOfDllULONGLONGinモジュールのベースアドレス。
NameLPCWSTRinシンボルの名前。シンボル名の最大サイズは MAX_SYM_NAME 文字です。
AddressULONGLONGinシンボルのアドレス。このアドレスは、指定したモジュールのアドレス範囲内である必要があります。
SizeDWORDinシンボルのサイズ(バイト単位)。このパラメーターは省略可能です。
FlagsDWORDinこのパラメーターは使用されません。

戻り値の型: BOOL

公式ドキュメント

SymAddSymbolW (Unicode) 関数は、指定したモジュールに仮想シンボルを追加します。

戻り値

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

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

解説(Remarks)

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

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

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして SymAddSymbol を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「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 SymAddSymbolW(
    HANDLE hProcess,
    ULONGLONG BaseOfDll,
    LPCWSTR Name,
    ULONGLONG Address,
    DWORD Size,
    DWORD Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SymAddSymbolW(
    IntPtr hProcess,   // HANDLE
    ulong BaseOfDll,   // ULONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] string Name,   // LPCWSTR
    ulong Address,   // ULONGLONG
    uint Size,   // DWORD
    uint Flags   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymAddSymbolW(
    hProcess As IntPtr,   ' HANDLE
    BaseOfDll As ULong,   ' ULONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> Name As String,   ' LPCWSTR
    Address As ULong,   ' ULONGLONG
    Size As UInteger,   ' DWORD
    Flags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' BaseOfDll : ULONGLONG
' Name : LPCWSTR
' Address : ULONGLONG
' Size : DWORD
' Flags : DWORD
Declare PtrSafe Function SymAddSymbolW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal BaseOfDll As LongLong, _
    ByVal Name As LongPtr, _
    ByVal Address As LongLong, _
    ByVal Size As Long, _
    ByVal Flags As Long) 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

SymAddSymbolW = ctypes.windll.dbghelp.SymAddSymbolW
SymAddSymbolW.restype = wintypes.BOOL
SymAddSymbolW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_ulonglong,  # BaseOfDll : ULONGLONG
    wintypes.LPCWSTR,  # Name : LPCWSTR
    ctypes.c_ulonglong,  # Address : ULONGLONG
    wintypes.DWORD,  # Size : DWORD
    wintypes.DWORD,  # Flags : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymAddSymbolW = Fiddle::Function.new(
  lib['SymAddSymbolW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # BaseOfDll : ULONGLONG
    Fiddle::TYPE_VOIDP,  # Name : LPCWSTR
    -Fiddle::TYPE_LONG_LONG,  # Address : ULONGLONG
    -Fiddle::TYPE_INT,  # Size : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymAddSymbolW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        BaseOfDll: u64,  // ULONGLONG
        Name: *const u16,  // LPCWSTR
        Address: u64,  // ULONGLONG
        Size: u32,  // DWORD
        Flags: u32  // DWORD
    ) -> 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 SymAddSymbolW(IntPtr hProcess, ulong BaseOfDll, [MarshalAs(UnmanagedType.LPWStr)] string Name, ulong Address, uint Size, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymAddSymbolW' -Namespace Win32 -PassThru
# $api::SymAddSymbolW(hProcess, BaseOfDll, Name, Address, Size, Flags)
#uselib "dbghelp.dll"
#func global SymAddSymbolW "SymAddSymbolW" wptr, wptr, wptr, wptr, wptr, wptr
; SymAddSymbolW hProcess, BaseOfDll, Name, Address, Size, Flags   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; BaseOfDll : ULONGLONG -> "wptr"
; Name : LPCWSTR -> "wptr"
; Address : ULONGLONG -> "wptr"
; Size : DWORD -> "wptr"
; Flags : DWORD -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymAddSymbolW "SymAddSymbolW" sptr, int64, wstr, int64, int, int
; res = SymAddSymbolW(hProcess, BaseOfDll, Name, Address, Size, Flags)
; hProcess : HANDLE -> "sptr"
; BaseOfDll : ULONGLONG -> "int64"
; Name : LPCWSTR -> "wstr"
; Address : ULONGLONG -> "int64"
; Size : DWORD -> "int"
; Flags : DWORD -> "int"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; BOOL SymAddSymbolW(HANDLE hProcess, ULONGLONG BaseOfDll, LPCWSTR Name, ULONGLONG Address, DWORD Size, DWORD Flags)
#uselib "dbghelp.dll"
#cfunc global SymAddSymbolW "SymAddSymbolW" intptr, int64, wstr, int64, int, int
; res = SymAddSymbolW(hProcess, BaseOfDll, Name, Address, Size, Flags)
; hProcess : HANDLE -> "intptr"
; BaseOfDll : ULONGLONG -> "int64"
; Name : LPCWSTR -> "wstr"
; Address : ULONGLONG -> "int64"
; Size : DWORD -> "int"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymAddSymbolW = dbghelp.NewProc("SymAddSymbolW")
)

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

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

typedef SymAddSymbolWNative = Int32 Function(Pointer<Void>, Uint64, Pointer<Utf16>, Uint64, Uint32, Uint32);
typedef SymAddSymbolWDart = int Function(Pointer<Void>, int, Pointer<Utf16>, int, int, int);
final SymAddSymbolW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymAddSymbolWNative, SymAddSymbolWDart>('SymAddSymbolW');
// hProcess : HANDLE -> Pointer<Void>
// BaseOfDll : ULONGLONG -> Uint64
// Name : LPCWSTR -> Pointer<Utf16>
// Address : ULONGLONG -> Uint64
// Size : DWORD -> Uint32
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymAddSymbolW(
  hProcess: THandle;   // HANDLE
  BaseOfDll: UInt64;   // ULONGLONG
  Name: PWideChar;   // LPCWSTR
  Address: UInt64;   // ULONGLONG
  Size: DWORD;   // DWORD
  Flags: DWORD   // DWORD
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymAddSymbolW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymAddSymbolW"
  c_SymAddSymbolW :: Ptr () -> Word64 -> CWString -> Word64 -> Word32 -> Word32 -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- BaseOfDll : ULONGLONG -> Word64
-- Name : LPCWSTR -> CWString
-- Address : ULONGLONG -> Word64
-- Size : DWORD -> Word32
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symaddsymbolw =
  foreign "SymAddSymbolW"
    ((ptr void) @-> uint64_t @-> (ptr uint16_t) @-> uint64_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* BaseOfDll : ULONGLONG -> uint64_t *)
(* Name : LPCWSTR -> (ptr uint16_t) *)
(* Address : ULONGLONG -> uint64_t *)
(* Size : DWORD -> uint32_t *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymAddSymbolW" sym-add-symbol-w :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (base-of-dll :uint64)   ; ULONGLONG
  (name (:string :encoding :utf-16le))   ; LPCWSTR
  (address :uint64)   ; ULONGLONG
  (size :uint32)   ; DWORD
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymAddSymbolW = Win32::API::More->new('dbghelp',
    'BOOL SymAddSymbolW(HANDLE hProcess, UINT64 BaseOfDll, LPCWSTR Name, UINT64 Address, DWORD Size, DWORD Flags)');
# my $ret = $SymAddSymbolW->Call($hProcess, $BaseOfDll, $Name, $Address, $Size, $Flags);
# hProcess : HANDLE -> HANDLE
# BaseOfDll : ULONGLONG -> UINT64
# Name : LPCWSTR -> LPCWSTR
# Address : ULONGLONG -> UINT64
# Size : DWORD -> DWORD
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

公式の関連項目