SymEnumTypesByName function (dbghelp.h)

Article
02/22/2024

Enumerates all user-defined types.

Syntax

BOOL IMAGEAPI SymEnumTypesByName(
  [in]           HANDLE                         hProcess,
  [in]           ULONG64                        BaseOfDll,
  [in, optional] PCSTR                          mask,
  [in]           PSYM_ENUMERATESYMBOLS_CALLBACK EnumSymbolsCallback,
  [in]           PVOID                          UserContext
);

Parameters

[in] hProcess

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

[in] BaseOfDll

The base address of the module.

[in, optional] mask

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

[in] EnumSymbolsCallback

A pointer to an SymEnumSymbolsProc callback function that receives the symbol information.

[in] UserContext

A user-defined value to be 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 information 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.

Requirements

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