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

UnDecorateSymbolNameW

関数
装飾されたC++シンボル名を可読形式へ復元する。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

DWORD UnDecorateSymbolNameW(
    LPCWSTR name,
    LPWSTR outputString,
    DWORD maxStringLength,
    DWORD flags
);

パラメーター

名前方向説明
nameLPCWSTRin装飾済みの C++ シンボル名。この名前は、先頭の文字が常に疑問符 (?) であることによって識別できます。
outputStringLPWSTRoutデコード解除された名前を受け取る文字列バッファへのポインター。
maxStringLengthDWORDinUnDecoratedName バッファのサイズ(文字数単位)。
flagsDWORDin

装飾済み名のデコードを解除する方法を指定するオプション。このパラメーターには、次の値の 0 個以上を指定できます。

意味
UNDNAME_32_BIT_DECODE
0x0800
32 ビットの装飾済み名のデコードを解除します。
UNDNAME_COMPLETE
0x0000
完全なデコード解除を有効にします。
UNDNAME_NAME_ONLY
0x1000
プライマリ宣言の名前のみをデコード解除します。[scope::]name を返します。テンプレートパラメーターは展開されます。
UNDNAME_NO_ACCESS_SPECIFIERS
0x0080
メンバーのアクセス指定子の展開を無効にします。
UNDNAME_NO_ALLOCATION_LANGUAGE
0x0010
宣言言語指定子の展開を無効にします。
UNDNAME_NO_ALLOCATION_MODEL
0x0008
宣言モデルの展開を無効にします。
UNDNAME_NO_ARGUMENTS
0x2000
関数の引数のデコードを解除しません。
UNDNAME_NO_CV_THISTYPE
0x0040
プライマリ宣言の this 型に対する CodeView 修飾子の展開を無効にします。
UNDNAME_NO_FUNCTION_RETURNS
0x0004
プライマリ宣言の戻り値の型の展開を無効にします。
UNDNAME_NO_LEADING_UNDERSCORES
0x0001
Microsoft キーワードから先頭のアンダースコアを除去します。
UNDNAME_NO_MEMBER_TYPE
0x0200
メンバーの static または virtual 属性の展開を無効にします。
UNDNAME_NO_MS_KEYWORDS
0x0002
Microsoft キーワードの展開を無効にします。
UNDNAME_NO_MS_THISTYPE
0x0020
プライマリ宣言の this 型に対する Microsoft キーワードの展開を無効にします。
UNDNAME_NO_RETURN_UDT_MODEL
0x0400
ユーザー定義型の戻り値に対する Microsoft モデルの展開を無効にします。
UNDNAME_NO_SPECIAL_SYMS
0x4000
vtable、vcall、vector、metatype などの特殊な名前のデコードを解除しません。
UNDNAME_NO_THISTYPE
0x0060
this 型に対するすべての修飾子を無効にします。
UNDNAME_NO_THROW_SIGNATURES
0x0100
関数および関数へのポインターに対する throw シグネチャの展開を無効にします。

戻り値の型: DWORD

公式ドキュメント

UnDecorateSymbolNameW (Unicode) 関数 (dbghelp.h) は、指定された装飾済み C++ シンボル名のデコードを解除します。

戻り値

関数が成功した場合、戻り値は UnDecoratedName バッファ内の文字数(NULL 終端文字を含まない)です。

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

関数が失敗して 0 を返した場合、UnDecoratedName バッファの内容は不定です。

解説(Remarks)

デコード解除されたシンボルを使用するには、SymSetOptions 関数を SYMOPT_UNDNAME オプションを指定して呼び出します。

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

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

例については、Retrieving Undecorated Symbol Names を参照してください。

メモ

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

DWORD UnDecorateSymbolNameW(
    LPCWSTR name,
    LPWSTR outputString,
    DWORD maxStringLength,
    DWORD flags
);
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint UnDecorateSymbolNameW(
    [MarshalAs(UnmanagedType.LPWStr)] string name,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder outputString,   // LPWSTR out
    uint maxStringLength,   // DWORD
    uint flags   // DWORD
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnDecorateSymbolNameW(
    <MarshalAs(UnmanagedType.LPWStr)> name As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> outputString As System.Text.StringBuilder,   ' LPWSTR out
    maxStringLength As UInteger,   ' DWORD
    flags As UInteger   ' DWORD
) As UInteger
End Function
' name : LPCWSTR
' outputString : LPWSTR out
' maxStringLength : DWORD
' flags : DWORD
Declare PtrSafe Function UnDecorateSymbolNameW Lib "dbghelp" ( _
    ByVal name As LongPtr, _
    ByVal outputString As LongPtr, _
    ByVal maxStringLength 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

UnDecorateSymbolNameW = ctypes.windll.dbghelp.UnDecorateSymbolNameW
UnDecorateSymbolNameW.restype = wintypes.DWORD
UnDecorateSymbolNameW.argtypes = [
    wintypes.LPCWSTR,  # name : LPCWSTR
    wintypes.LPWSTR,  # outputString : LPWSTR out
    wintypes.DWORD,  # maxStringLength : 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')
UnDecorateSymbolNameW = Fiddle::Function.new(
  lib['UnDecorateSymbolNameW'],
  [
    Fiddle::TYPE_VOIDP,  # name : LPCWSTR
    Fiddle::TYPE_VOIDP,  # outputString : LPWSTR out
    -Fiddle::TYPE_INT,  # maxStringLength : DWORD
    -Fiddle::TYPE_INT,  # flags : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn UnDecorateSymbolNameW(
        name: *const u16,  // LPCWSTR
        outputString: *mut u16,  // LPWSTR out
        maxStringLength: u32,  // DWORD
        flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint UnDecorateSymbolNameW([MarshalAs(UnmanagedType.LPWStr)] string name, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder outputString, uint maxStringLength, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_UnDecorateSymbolNameW' -Namespace Win32 -PassThru
# $api::UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
#uselib "dbghelp.dll"
#func global UnDecorateSymbolNameW "UnDecorateSymbolNameW" wptr, wptr, wptr, wptr
; UnDecorateSymbolNameW name, varptr(outputString), maxStringLength, flags   ; 戻り値は stat
; name : LPCWSTR -> "wptr"
; outputString : LPWSTR out -> "wptr"
; maxStringLength : DWORD -> "wptr"
; flags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global UnDecorateSymbolNameW "UnDecorateSymbolNameW" wstr, var, int, int
; res = UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
; name : LPCWSTR -> "wstr"
; outputString : LPWSTR out -> "var"
; maxStringLength : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD UnDecorateSymbolNameW(LPCWSTR name, LPWSTR outputString, DWORD maxStringLength, DWORD flags)
#uselib "dbghelp.dll"
#cfunc global UnDecorateSymbolNameW "UnDecorateSymbolNameW" wstr, var, int, int
; res = UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
; name : LPCWSTR -> "wstr"
; outputString : LPWSTR out -> "var"
; maxStringLength : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procUnDecorateSymbolNameW = dbghelp.NewProc("UnDecorateSymbolNameW")
)

// name (LPCWSTR), outputString (LPWSTR out), maxStringLength (DWORD), flags (DWORD)
r1, _, err := procUnDecorateSymbolNameW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(name))),
	uintptr(outputString),
	uintptr(maxStringLength),
	uintptr(flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function UnDecorateSymbolNameW(
  name: PWideChar;   // LPCWSTR
  outputString: PWideChar;   // LPWSTR out
  maxStringLength: DWORD;   // DWORD
  flags: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'UnDecorateSymbolNameW';
result := DllCall("dbghelp\UnDecorateSymbolNameW"
    , "WStr", name   ; LPCWSTR
    , "Ptr", outputString   ; LPWSTR out
    , "UInt", maxStringLength   ; DWORD
    , "UInt", flags   ; DWORD
    , "UInt")   ; return: DWORD
●UnDecorateSymbolNameW(name, outputString, maxStringLength, flags) = DLL("dbghelp.dll", "dword UnDecorateSymbolNameW(char*, char*, dword, dword)")
# 呼び出し: UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
# name : LPCWSTR -> "char*"
# outputString : LPWSTR out -> "char*"
# maxStringLength : 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 UnDecorateSymbolNameW(
    name: [*c]const u16, // LPCWSTR
    outputString: [*c]u16, // LPWSTR out
    maxStringLength: u32, // DWORD
    flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc UnDecorateSymbolNameW(
    name: WideCString,  # LPCWSTR
    outputString: ptr uint16,  # LPWSTR out
    maxStringLength: uint32,  # DWORD
    flags: uint32  # DWORD
): uint32 {.importc: "UnDecorateSymbolNameW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
uint UnDecorateSymbolNameW(
    const(wchar)* name,   // LPCWSTR
    wchar* outputString,   // LPWSTR out
    uint maxStringLength,   // DWORD
    uint flags   // DWORD
);
ccall((:UnDecorateSymbolNameW, "dbghelp.dll"), stdcall, UInt32,
      (Cwstring, Ptr{UInt16}, UInt32, UInt32),
      name, outputString, maxStringLength, flags)
# name : LPCWSTR -> Cwstring
# outputString : LPWSTR out -> Ptr{UInt16}
# maxStringLength : DWORD -> UInt32
# flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t UnDecorateSymbolNameW(
    const uint16_t* name,
    uint16_t* outputString,
    uint32_t maxStringLength,
    uint32_t flags);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
-- name : LPCWSTR
-- outputString : LPWSTR out
-- maxStringLength : 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 UnDecorateSymbolNameW = lib.func('__stdcall', 'UnDecorateSymbolNameW', 'uint32_t', ['str16', 'uint16_t *', 'uint32_t', 'uint32_t']);
// UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
// name : LPCWSTR -> 'str16'
// outputString : LPWSTR out -> 'uint16_t *'
// maxStringLength : DWORD -> 'uint32_t'
// flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  UnDecorateSymbolNameW: { parameters: ["buffer", "buffer", "u32", "u32"], result: "u32" },
});
// lib.symbols.UnDecorateSymbolNameW(name, outputString, maxStringLength, flags)
// name : LPCWSTR -> "buffer"
// outputString : LPWSTR out -> "buffer"
// maxStringLength : DWORD -> "u32"
// flags : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t UnDecorateSymbolNameW(
    const uint16_t* name,
    uint16_t* outputString,
    uint32_t maxStringLength,
    uint32_t flags);
C, "dbghelp.dll");
// $ffi->UnDecorateSymbolNameW(name, outputString, maxStringLength, flags);
// name : LPCWSTR
// outputString : LPWSTR out
// maxStringLength : 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);
    int UnDecorateSymbolNameW(
        WString name,   // LPCWSTR
        char[] outputString,   // LPWSTR out
        int maxStringLength,   // DWORD
        int flags   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun UnDecorateSymbolNameW = UnDecorateSymbolNameW(
    name : UInt16*,   # LPCWSTR
    outputString : UInt16*,   # LPWSTR out
    maxStringLength : UInt32,   # DWORD
    flags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UnDecorateSymbolNameWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32);
typedef UnDecorateSymbolNameWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int);
final UnDecorateSymbolNameW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<UnDecorateSymbolNameWNative, UnDecorateSymbolNameWDart>('UnDecorateSymbolNameW');
// name : LPCWSTR -> Pointer<Utf16>
// outputString : LPWSTR out -> Pointer<Utf16>
// maxStringLength : DWORD -> Uint32
// flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnDecorateSymbolNameW(
  name: PWideChar;   // LPCWSTR
  outputString: PWideChar;   // LPWSTR out
  maxStringLength: DWORD;   // DWORD
  flags: DWORD   // DWORD
): DWORD; stdcall;
  external 'dbghelp.dll' name 'UnDecorateSymbolNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnDecorateSymbolNameW"
  c_UnDecorateSymbolNameW :: CWString -> CWString -> Word32 -> Word32 -> IO Word32
-- name : LPCWSTR -> CWString
-- outputString : LPWSTR out -> CWString
-- maxStringLength : DWORD -> Word32
-- flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let undecoratesymbolnamew =
  foreign "UnDecorateSymbolNameW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* name : LPCWSTR -> (ptr uint16_t) *)
(* outputString : LPWSTR out -> (ptr uint16_t) *)
(* maxStringLength : 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 ("UnDecorateSymbolNameW" un-decorate-symbol-name-w :convention :stdcall) :uint32
  (name (:string :encoding :utf-16le))   ; LPCWSTR
  (output-string :pointer)   ; LPWSTR out
  (max-string-length :uint32)   ; DWORD
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnDecorateSymbolNameW = Win32::API::More->new('dbghelp',
    'DWORD UnDecorateSymbolNameW(LPCWSTR name, LPWSTR outputString, DWORD maxStringLength, DWORD flags)');
# my $ret = $UnDecorateSymbolNameW->Call($name, $outputString, $maxStringLength, $flags);
# name : LPCWSTR -> LPCWSTR
# outputString : LPWSTR out -> LPWSTR
# maxStringLength : DWORD -> DWORD
# flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

公式の関連項目