Enumerates all symbols in a process.
BOOL WINAPI SymEnumSymbols( _In_ HANDLE hProcess, _In_ ULONG64 BaseOfDll, _In_opt_ PCTSTR Mask, _In_ PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback, _In_opt_ const PVOID UserContext );
- hProcess [in]
A handle to a process. This handle must have been previously passed to the SymInitialize function.
- BaseOfDll [in]
The base address of the module. If this value is zero and Mask contains an exclamation point (!), the function looks across modules. If this value is zero and Mask does not contain an exclamation point, the function uses the scope established by the SymSetContext function.
- Mask [in, optional]
A wildcard string that indicates the names of the symbols to be enumerated. The text can optionally contain the wildcards, "*" and "?".
To specify a specific module or set of modules, begin the text with a wildcard string specifying the module, followed by an exclamation point. When specifying a module, BaseOfDll is ignored.
If BaseOfDll is not zero, then SymEnumSymbols will look for a global symbol named "foo".
If BaseOfDll is zero, then SymEnumSymbols will look for a local symbol named "foo" within the scope established by the most recent call to the SymSetContext function.
If BaseOfDll is not zero, then SymEnumSymbols will look for a global symbol that starts with "foo" and contains one extra character afterwards, such as "fool" and "foot".
If BaseOfDll is zero, then SymEnumSymbols will look for a symbol that starts with "foo" and contains one extra character afterwards, such as "fool" and "foot". The search would be within the scope established by the most recent call to the SymSetContext function.
SymEnumSymbols will look in every loaded module that starts with the text "foo" for a symbol called "bar". It could find matches such as these, "foot!bar", "footlocker!bar", and "fool!bar".
SymEnumSymbols will enumerate every symbol in every loaded module.
- EnumSymbolsCallback [in]
A SymEnumSymbolsProc callback function that receives the symbol information.
- UserContext [in, optional]
A user-defined value that is passed to the callback function, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides context for the callback function.
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.
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.
To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.
For an example, see Enumerating Symbols.
|DbgHelp.dll 5.1 or later|
Unicode and ANSI names
|SymEnumSymbolsW (Unicode) and SymEnumSymbols (ANSI)|
Build date: 10/26/2012