PSYM_ENUMSYMBOLS_CALLBACK callback function (dbghelp.h)

Article
02/22/2024

An application-defined callback function used with the SymEnumerateSymbols64 function. It is called once for each enumerated symbol, and receives the symbol information.

The PSYM_ENUMSYMBOLS_CALLBACK64 and PSYM_ENUMSYMBOLS_CALLBACK64W types define a pointer to this callback function. SymEnumerateSymbolsProc64 is a placeholder for the application-defined function name.

Note This function is provided only for compatibility. Applications should use SymEnumSymbols.

Syntax

PSYM_ENUMSYMBOLS_CALLBACK PsymEnumsymbolsCallback;

BOOL PsymEnumsymbolsCallback(
  [in]           PCSTR SymbolName,
  [in]           ULONG SymbolAddress,
  [in]           ULONG SymbolSize,
  [in, optional] PVOID UserContext
)
{...}

Parameters

[in] SymbolName

The name of the symbol. The name can be undecorated if the SYMOPT_UNDNAME option is used with the SymSetOptions function.

[in] SymbolAddress

The virtual address for the beginning of the symbol.

[in] SymbolSize

The size of the symbol, in bytes. The size is calculated and is actually a best-guess value. In some cases, the value can be zero.

[in, optional] UserContext

The user-defined value specified in SymEnumerateSymbols64, or NULL. Typically, this parameter is used by an application to pass a pointer to a data structure that lets the callback function establish some type of context.

Return value

If the function returns TRUE, the enumeration will continue.

If the function returns FALSE, the enumeration will stop.

Remarks

The calling application is called once per symbol until all the symbols are enumerated or until the enumeration callback function returns FALSE.

This callback function supersedes the PSYM_ENUMSYMBOLS_CALLBACK callback function. PSYM_ENUMSYMBOLS_CALLBACK is defined as follows in Dbghelp.h.

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define PSYM_ENUMSYMBOLS_CALLBACK PSYM_ENUMSYMBOLS_CALLBACK64
#define PSYM_ENUMSYMBOLS_CALLBACKW PSYM_ENUMSYMBOLS_CALLBACK64W
#else
typedef BOOL
(CALLBACK *PSYM_ENUMSYMBOLS_CALLBACK)(
    __in PCSTR SymbolName,
    __in ULONG SymbolAddress,
    __in ULONG SymbolSize,
    __in_opt PVOID UserContext
    );

typedef BOOL
(CALLBACK *PSYM_ENUMSYMBOLS_CALLBACKW)(
    __in PCWSTR SymbolName,
    __in ULONG SymbolAddress,
    __in ULONG SymbolSize,
    __in_opt PVOID UserContext
    );
#endif

Requirements

Requirement	Value
Target Platform	Windows
Header	dbghelp.h
Redistributable	DbgHelp.dll 5.1 or later