SymEnumerateSymbols function

Enumerates all the symbols for a specified module.

Note  This function is provided only for compatibility. Applications should use SymEnumSymbols, which is faster and more powerful.
 

Syntax

DBHLP_DEPRECIATED BOOL IMAGEAPI SymEnumerateSymbols(
  HANDLE                    hProcess,
  ULONG                     BaseOfDll,
  PSYM_ENUMSYMBOLS_CALLBACK EnumSymbolsCallback,
  PVOID                     UserContext
);

Parameters

hProcess

A handle to the process. This handle must have been previously passed to the SymInitialize function.

BaseOfDll

The base address of the module for which symbols are to be enumerated.

EnumSymbolsCallback

The callback function that receives the symbol information. For more information, see SymEnumerateSymbolsProc64.

UserContext

A user-defined value or NULL. This value is passed to the callback function. Typically, this parameter is used by an application to pass a pointer to a data structure that enables the callback function establish some type of context.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

The SymEnumerateSymbols64 function enumerates all the symbols for the specified module. The module information is located by the BaseOfDll parameter. The callback function is called once per symbol and is passed the information for each symbol.

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

The Unicode version of this function, SymEnumerateSymbolsW64 is defined as follows in Dbghelp.h.


BOOL
IMAGEAPI
SymEnumerateSymbolsW64(
    __in HANDLE hProcess,
    __in ULONG64 BaseOfDll,
    __in PSYM_ENUMSYMBOLS_CALLBACK64W EnumSymbolsCallback,
    __in_opt PVOID UserContext
    );

This function supersedes the SymEnumerateSymbols function. For more information, see Updated Platform Support. SymEnumerateSymbols is defined as follows in Dbghelp.h.

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymEnumerateSymbols SymEnumerateSymbols64
#define SymEnumerateSymbolsW SymEnumerateSymbolsW64
#else
BOOL
IMAGEAPI
SymEnumerateSymbols(
    __in HANDLE hProcess,
    __in ULONG BaseOfDll,
    __in PSYM_ENUMSYMBOLS_CALLBACK EnumSymbolsCallback,
    __in_opt PVOID UserContext
    );

BOOL
IMAGEAPI
SymEnumerateSymbolsW(
    __in HANDLE hProcess,
    __in ULONG BaseOfDll,
    __in PSYM_ENUMSYMBOLS_CALLBACKW EnumSymbolsCallback,
    __in_opt PVOID UserContext
    );
#endif

Requirements

   
Target Platform Windows
Header dbghelp.h
Library Dbghelp.lib
DLL Dbghelp.dll
Redistributable DbgHelp.dll 5.1 or later

See Also

DbgHelp Functions

SymEnumSymbols

SymEnumerateSymbolsProc64

SymInitialize