SymFromName Function

Retrieves symbol information for the specified name.

BOOL WINAPI SymFromName(
  __in          HANDLE hProcess,
  __in          PCTSTR Name,
  __out         PSYMBOL_INFO Symbol
);

Parameters

hProcess

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

Name

The name of the symbol to be located.

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.

Example Code

For an example, see Retrieving Symbol Information by Name.

Requirements

Redistributable	Requires DbgHelp.dll 5.1 or later.
Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymFromNameW (Unicode) and SymFromName (ANSI).

See Also

DbgHelp FunctionsSYMBOL_INFO

Send comments about this topic to Microsoft

Build date: 9/25/2007