SymEnumSymbolsProc Callback Function

Debug Help Library

SymEnumSymbolsProc Callback Function

An application-defined callback function used with the SymEnumSymbols or SymEnumTypes function.

The PSYM_ENUMERATESYMBOLS_CALLBACK type defines a pointer to this callback function. SymEnumSymbolsProc is a placeholder for the application-defined function name.

BOOL CALLBACK SymEnumSymbolsProc(
  [in]                 PSYMBOL_INFO pSymInfo,
  [in]                 ULONG SymbolSize,
  [in]                 PVOID UserContext
);

Parameters

pSymInfo

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

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.

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

Redistributable

Requires DbgHelp.dll 5.1 or later.

Header

Declared in DbgHelp.h.

Unicode

Implemented as PSYM_ENUMERATESYMBOLS_CALLBACKW (Unicode) and PSYM_ENUMERATESYMBOLS_CALLBACK (ANSI).

See Also

DbgHelp FunctionsSymEnumSymbols
SymEnumTypes


Send comments about this topic to Microsoft

Build date: 9/25/2007

© 2007 Microsoft Corporation. All rights reserved.