SymFromName function (dbghelp.h)

Article
02/22/2024

Retrieves symbol information for the specified name.

Syntax

BOOL IMAGEAPI SymFromName(
  [in]      HANDLE       hProcess,
  [in]      PCSTR        Name,
  [in, out] PSYMBOL_INFO Symbol
);

Parameters

[in] hProcess

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

[in] Name

The name of the symbol to be located.

[in, out] Symbol

A pointer to a SYMBOL_INFO structure that provides information about the symbol.

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.

Examples

For an example, see Retrieving Symbol Information by Name.

Requirements

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

Share via