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

BOOL CALLBACK SymEnumSymbolsProc(
  __in      PSYMBOL_INFO pSymInfo,
  __in      ULONG SymbolSize,
  __in_opt  PVOID UserContext
);

Parameters

pSymInfo [in]

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

SymbolSize [in]

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

UserContext [in, optional]

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

See Also

DbgHelp Functions
SymEnumSymbols
SymEnumTypes
SymEnumTypesByName

Send comments about this topic to Microsoft

Build date: 7/1/2008