SymFromAddr function (dbghelp.h)

Article
02/22/2024

Retrieves symbol information for the specified address.

Syntax

BOOL IMAGEAPI SymFromAddr(
  [in]            HANDLE       hProcess,
  [in]            DWORD64      Address,
  [out, optional] PDWORD64     Displacement,
  [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] Address

The address for which a symbol should be located. The address does not have to be on a symbol boundary. If the address comes after the beginning of a symbol and before the end of the symbol, the symbol is found.

[out, optional] Displacement

The displacement from the beginning of the symbol, or zero.

[in, out] Symbol

A pointer to a SYMBOL_INFO structure that provides information about the symbol. The symbol name is variable in length; therefore this buffer must be large enough to hold the name stored at the end of the SYMBOL_INFO structure. Be sure to set the MaxNameLen member to the number of bytes reserved for the name.

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 Address.

Requirements

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

Share via