Edit

Share via

SymFromIndex function (dbghelp.h)

  • Article

Retrieves symbol information for the specified index.

Syntax

BOOL IMAGEAPI SymFromIndex(
  [in]      HANDLE       hProcess,
  [in]      ULONG64      BaseOfDll,
  [in]      DWORD        Index,
  [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] BaseOfDll

The base address of the module.

[in] Index

A unique value for the symbol.

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

Requirements

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

See also

DbgHelp Functions

SYMBOL_INFO