SymFromIndex Function

Debug Help Library

SymFromIndex Function

Retrieves symbol information for the specified index.

BOOL WINAPI SymFromIndex(
  __in          HANDLE hProcess,
  __in          ULONG64 BaseOfDll,
  __in          DWORD Index,
  __out         PSYMBOL_INFO Symbol
);

Parameters

hProcess

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

BaseOfDll

The base address of the module.

Index

A unique value for the symbol.

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

Redistributable

Requires DbgHelp.dll 6.2 or later.

Header

Declared in Dbghelp.h.

Library

Use Dbghelp.lib.

DLL

Requires Dbghelp.dll.

Unicode

Implemented as SymFromIndexW (Unicode) and SymFromIndex (ANSI).

See Also

DbgHelp FunctionsSYMBOL_INFO


Send comments about this topic to Microsoft

Build date: 9/25/2007

© 2007 Microsoft Corporation. All rights reserved.