SymEnumerateSymbolsProc64 Callback Function

Debug Help Library

SymEnumerateSymbolsProc64 Callback Function

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 type defines 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.

BOOL CALLBACK SymEnumerateSymbolsProc64(
  [in]                 PTSTR SymbolName,
  [in]                 DWORD64 SymbolAddress,
  [in]                 ULONG SymbolSize,
  [in]                 PVOID UserContext
);

Parameters

SymbolName

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

SymbolAddress

The virtual address for the beginning of the symbol.

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.

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.

Requirements

Redistributable

Requires DbgHelp.dll 5.1 or later.

Header

Declared in DbgHelp.h.

See Also

DbgHelp FunctionsSymEnumerateSymbols64
SymEnumSymbols


Send comments about this topic to Microsoft

Build date: 9/25/2007

© 2007 Microsoft Corporation. All rights reserved.