SymGetTypeFromNameW function (dbghelp.h)

Article
08/09/2022

Retrieves a type index for the specified type name.

Syntax

BOOL IMAGEAPI SymGetTypeFromNameW(
  [in]      HANDLE        hProcess,
  [in]      ULONG64       BaseOfDll,
  [in]      PCWSTR        Name,
  [in, out] PSYMBOL_INFOW Symbol
);

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] Name

The name of the type.

[in, out] Symbol

A pointer to a SYMBOL_INFO structure. The TypeIndex member contains the type index.

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

To retrieve information about the type, pass the type index to the SymGetTypeInfo function.

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.

Note

The dbghelp.h header defines SymGetTypeFromName as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

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