Edit

PSYM_ENUMERATESYMBOLS_CALLBACK callback function (dbghelp.h)

  • Article

An application-defined callback function used with the SymEnumSymbols, SymEnumTypes, and SymEnumTypesByName functions.

The PSYM_ENUMERATESYMBOLS_CALLBACK and PSYM_ENUMERATESYMBOLS_CALLBACKW types define a pointer to this callback function. SymEnumSymbolsProc is a placeholder for the application-defined function name.

Syntax

PSYM_ENUMERATESYMBOLS_CALLBACK PsymEnumeratesymbolsCallback;

BOOL PsymEnumeratesymbolsCallback(
  [in]           PSYMBOL_INFO pSymInfo,
  [in]           ULONG SymbolSize,
  [in, optional] PVOID UserContext
)
{...}

Parameters

[in] pSymInfo

A pointer to a SYMBOL_INFO structure that provides information about the symbol.

[in] SymbolSize

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

[in, optional] UserContext

The user-defined value passed from the SymEnumSymbols or SymEnumTypes function, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides context information for the callback function.

Return value

If the function returns TRUE, the enumeration will continue.

If the function returns FALSE, the enumeration will stop.

Requirements

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

See also

DbgHelp Functions

SYMBOL_INFO

SymEnumSymbols

SymEnumTypes

SymEnumTypesByName