ホーム › System.Diagnostics.Debug › UnDecorateSymbolName

UnDecorateSymbolName

関数

装飾されたC++シンボル名を可読形式へ復元する。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

DWORD UnDecorateSymbolName(
    LPCSTR name,
    LPSTR outputString,
    DWORD maxStringLength,
    DWORD flags
);

パラメーター

名前

型

方向

説明

name

LPCSTR

修飾済み (decorated) の C++ シンボル名。この名前は、名前の先頭文字が常に疑問符 (?) であることによって識別できます。

outputString

LPSTR

out

修飾解除後の名前を受け取る文字列バッファへのポインター。

maxStringLength

DWORD

UnDecoratedName バッファのサイズ(文字数)。

flags

DWORD

修飾済み名をどのように修飾解除するかのオプション。このパラメーターには、ゼロまたは次の値の 1 つ以上を指定できます。

値	意味
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

公式ドキュメント

UnDecorateSymbolName 関数 (dbghelp.h) は、指定された修飾済み (decorated) C++ シンボル名の修飾を解除します。

戻り値

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

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

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

解説(Remarks)

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

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

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

例

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

DWORD UnDecorateSymbolName(
    LPCSTR name,
    LPSTR outputString,
    DWORD maxStringLength,
    DWORD flags
);

[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint UnDecorateSymbolName(
    [MarshalAs(UnmanagedType.LPStr)] string name,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder outputString,   // LPSTR out
    uint maxStringLength,   // DWORD
    uint flags   // DWORD
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnDecorateSymbolName(
    <MarshalAs(UnmanagedType.LPStr)> name As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> outputString As System.Text.StringBuilder,   ' LPSTR out
    maxStringLength As UInteger,   ' DWORD
    flags As UInteger   ' DWORD
) As UInteger
End Function

' name : LPCSTR
' outputString : LPSTR out
' maxStringLength : DWORD
' flags : DWORD
Declare PtrSafe Function UnDecorateSymbolName Lib "dbghelp" ( _
    ByVal name As String, _
    ByVal outputString As String, _
    ByVal maxStringLength As Long, _
    ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

UnDecorateSymbolName = ctypes.windll.dbghelp.UnDecorateSymbolName
UnDecorateSymbolName.restype = wintypes.DWORD
UnDecorateSymbolName.argtypes = [
    wintypes.LPCSTR,  # name : LPCSTR
    wintypes.LPSTR,  # outputString : LPSTR 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')
UnDecorateSymbolName = Fiddle::Function.new(
  lib['UnDecorateSymbolName'],
  [
    Fiddle::TYPE_VOIDP,  # name : LPCSTR
    Fiddle::TYPE_VOIDP,  # outputString : LPSTR out
    -Fiddle::TYPE_INT,  # maxStringLength : DWORD
    -Fiddle::TYPE_INT,  # flags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn UnDecorateSymbolName(
        name: *const u8,  // LPCSTR
        outputString: *mut u8,  // LPSTR out
        maxStringLength: u32,  // DWORD
        flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern uint UnDecorateSymbolName([MarshalAs(UnmanagedType.LPStr)] string name, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder outputString, uint maxStringLength, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_UnDecorateSymbolName' -Namespace Win32 -PassThru
# $api::UnDecorateSymbolName(name, outputString, maxStringLength, flags)

#uselib "dbghelp.dll"
#func global UnDecorateSymbolName "UnDecorateSymbolName" sptr, sptr, sptr, sptr
; UnDecorateSymbolName name, varptr(outputString), maxStringLength, flags   ; 戻り値は stat
; name : LPCSTR -> "sptr"
; outputString : LPSTR out -> "sptr"
; maxStringLength : DWORD -> "sptr"
; flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global UnDecorateSymbolName "UnDecorateSymbolName" str, var, int, int
; res = UnDecorateSymbolName(name, outputString, maxStringLength, flags)
; name : LPCSTR -> "str"
; outputString : LPSTR out -> "var"
; maxStringLength : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global UnDecorateSymbolName "UnDecorateSymbolName" str, sptr, int, int
; res = UnDecorateSymbolName(name, varptr(outputString), maxStringLength, flags)
; name : LPCSTR -> "str"
; outputString : LPSTR out -> "sptr"
; maxStringLength : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。