Edit

Share via

SymUnDName function (dbghelp.h)

  • Article

Undecorates a decorated C++ symbol name.

Applications can also use the UnDecorateSymbolName function.

Syntax

BOOL IMAGEAPI SymUnDName(
  [in]  PIMAGEHLP_SYMBOL sym,
  [out] PSTR             UnDecName,
  [in]  DWORD            UnDecNameLength
);

Parameters

[in] sym

A pointer to an IMAGEHLP_SYMBOL64 structure that specifies the symbol to be undecorated.

[out] UnDecName

A pointer to a buffer that receives the undecorated name.

[in] UnDecNameLength

The size of the UnDecName buffer, in characters.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

This function supersedes the SymUnDName function. For more information, see Updated Platform Support. SymUnDName is defined as follows in 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

Requirements

Requirement Value
Target Platform Windows
Header dbghelp.h
Library Dbghelp.lib
DLL Dbghelp.dll
Redistributable DbgHelp.dll 5.1 or later

See also

DbgHelp Functions

UnDecorateSymbolName