SymEnumSymbols Function

Enumerates all symbols in a process.

BOOL WINAPI SymEnumSymbols(
  __in          HANDLE hProcess,
  __in          ULONG64 BaseOfDll,
  __in          PCTSTR Mask,
  __in          PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
  __in          PVOID UserContext
);

Parameters

hProcess

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

BaseOfDll

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

A regular expression that indicates the names of the symbols to be enumerated. To specify a module name, use the !mod syntax.

EnumSymbolsCallback

A SymEnumSymbolsProc callback function that receives the symbol information.

UserContext

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.

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

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.

Example Code

For an example, see Enumerating Symbols.

Requirements

See Also

DbgHelp FunctionsSymEnumSymbolsProc

Send comments about this topic to Microsoft

Build date: 9/25/2007