Skip to content

Latest commit

 

History

History
154 lines (115 loc) · 5.18 KB

nf-dbghelp-symenumeratesymbols.md

File metadata and controls

154 lines (115 loc) · 5.18 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dbghelp.SymEnumerateSymbols
SymEnumerateSymbols function (dbghelp.h)
The SymEnumerateSymbols function (dbghelp.h) enumerates all the symbols for a specified module.
SymEnumerateSymbols
SymEnumerateSymbols function
SymEnumerateSymbols64
SymEnumerateSymbols64 function
SymEnumerateSymbolsW
SymEnumerateSymbolsW64
_win32_symenumeratesymbols64
base.symenumeratesymbols64
dbghelp/SymEnumerateSymbols
dbghelp/SymEnumerateSymbols64
dbghelp/SymEnumerateSymbolsW
dbghelp/SymEnumerateSymbolsW64
base\symenumeratesymbols64.htm
Debug
f1aa710c-fbe5-4c9a-9956-5bd872b4b5be
08/04/2022
SymEnumerateSymbols, SymEnumerateSymbols function, SymEnumerateSymbols64, SymEnumerateSymbols64 function, SymEnumerateSymbolsW, SymEnumerateSymbolsW64, _win32_symenumeratesymbols64, base.symenumeratesymbols64, dbghelp/SymEnumerateSymbols, dbghelp/SymEnumerateSymbols64, dbghelp/SymEnumerateSymbolsW, dbghelp/SymEnumerateSymbolsW64
dbghelp.h
Windows
SymEnumerateSymbolsW64 (Unicode) and SymEnumerateSymbols64 (ANSI)
Dbghelp.lib
Dbghelp.dll
Windows
DbgHelp.dll 5.1 or later
19H1
SymEnumerateSymbols
dbghelp/SymEnumerateSymbols
c++
APIRef
kbSyntax
DllExport
Dbghelp.dll
SymEnumerateSymbols64
SymEnumerateSymbols64
SymEnumerateSymbolsW64
SymEnumerateSymbols
SymEnumerateSymbolsW

SymEnumerateSymbols function

-description

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.
 

-parameters

-param hProcess [in]

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

-param BaseOfDll [in]

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

-param EnumSymbolsCallback [in]

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

-param UserContext [in, optional]

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.

-returns

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

-see-also

DbgHelp Functions

SymEnumSymbols

SymEnumerateSymbolsProc64

SymInitialize