SymNext function (dbghelp.h)

Article
02/22/2024

Retrieves symbol information for the next symbol.

Syntax

BOOL IMAGEAPI SymNext(
  [in]      HANDLE       hProcess,
  [in, out] PSYMBOL_INFO si
);

Parameters

[in] hProcess

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

[in, out] si

A pointer to a SYMBOL_INFO structure that provides information about the current symbol. Upon return, the structure contains information about the next 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

This function requires that the SYMBOL_INFO structure have valid data for the current symbol. The next symbol is the symbol with the virtual address that is next in the sequence.

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.

Requirements

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