SymEnumTypesByName Function

[This documentation is preliminary and is subject to change.]

Enumerates all user-defined types.

BOOL WINAPI SymEnumTypesByName(
  __in          HANDLE hProcess,
  __in          ULONG64 BaseOfDll,
  __in_opt      PCSTR 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.

mask

TBD

EnumSymbolsCallback

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

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

Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymEnumTypesByNameW (Unicode) and SymEnumTypesByName (ANSI).

See Also

DbgHelp FunctionsSymEnumSymbolsProc

Send comments about this topic to Microsoft

Build date: 9/25/2007