ホーム › System.Diagnostics.Debug › SymUnDName

SymUnDName

関数

装飾されたシンボル名を元の名前に復元する。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

// dbghelp.dll
#include <windows.h>

BOOL SymUnDName(
    IMAGEHLP_SYMBOL* sym,
    LPSTR UnDecName,
    DWORD UnDecNameLength
);

パラメーター

名前	型	方向	説明
sym	IMAGEHLP_SYMBOL*	in	装飾を解除するシンボルを指定する IMAGEHLP_SYMBOL64 構造体へのポインターです。
UnDecName	LPSTR	out	装飾解除後の名前を受け取るバッファーへのポインターです。
UnDecNameLength	DWORD	in	UnDecName バッファーのサイズ(文字数)です。

戻り値の型: BOOL

公式ドキュメント

装飾された C++ シンボル名の装飾を解除します。(SymUnDName)

戻り値

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

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

解説(Remarks)

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

この関数は SymUnDName 関数に取って代わるものです。詳細については、 Updated Platform Support を参照してください。SymUnDName は Dbghelp.h で次のように定義されています。

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymUnDName SymUnDName64
#else
BOOL
IMAGEAPI
SymUnDName(
    __in PIMAGEHLP_SYMBOL sym,  
    __out_ecount(UnDecNameLength) PSTR UnDecName,   
    __in DWORD UnDecNameLength 
    );
#endif

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

各言語での呼び出し定義

// dbghelp.dll
#include <windows.h>

BOOL SymUnDName(
    IMAGEHLP_SYMBOL* sym,
    LPSTR UnDecName,
    DWORD UnDecNameLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymUnDName(
    IntPtr sym,   // IMAGEHLP_SYMBOL*
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder UnDecName,   // LPSTR out
    uint UnDecNameLength   // DWORD
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymUnDName(
    sym As IntPtr,   ' IMAGEHLP_SYMBOL*
    <MarshalAs(UnmanagedType.LPStr)> UnDecName As System.Text.StringBuilder,   ' LPSTR out
    UnDecNameLength As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' sym : IMAGEHLP_SYMBOL*
' UnDecName : LPSTR out
' UnDecNameLength : DWORD
Declare PtrSafe Function SymUnDName Lib "dbghelp" ( _
    ByVal sym As LongPtr, _
    ByVal UnDecName As String, _
    ByVal UnDecNameLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SymUnDName = ctypes.windll.dbghelp.SymUnDName
SymUnDName.restype = wintypes.BOOL
SymUnDName.argtypes = [
    ctypes.c_void_p,  # sym : IMAGEHLP_SYMBOL*
    wintypes.LPSTR,  # UnDecName : LPSTR out
    wintypes.DWORD,  # UnDecNameLength : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymUnDName = Fiddle::Function.new(
  lib['SymUnDName'],
  [
    Fiddle::TYPE_VOIDP,  # sym : IMAGEHLP_SYMBOL*
    Fiddle::TYPE_VOIDP,  # UnDecName : LPSTR out
    -Fiddle::TYPE_INT,  # UnDecNameLength : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "dbghelp")]
extern "system" {
    fn SymUnDName(
        sym: *mut IMAGEHLP_SYMBOL,  // IMAGEHLP_SYMBOL*
        UnDecName: *mut u8,  // LPSTR out
        UnDecNameLength: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool SymUnDName(IntPtr sym, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder UnDecName, uint UnDecNameLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymUnDName' -Namespace Win32 -PassThru
# $api::SymUnDName(sym, UnDecName, UnDecNameLength)

#uselib "dbghelp.dll"
#func global SymUnDName "SymUnDName" sptr, sptr, sptr
; SymUnDName varptr(sym), varptr(UnDecName), UnDecNameLength   ; 戻り値は stat
; sym : IMAGEHLP_SYMBOL* -> "sptr"
; UnDecName : LPSTR out -> "sptr"
; UnDecNameLength : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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