SymGetSymNext function (dbghelp.h)

Article
02/22/2024

Retrieves the symbol information for the next symbol.

Note This function is provided only for compatibility. Applications should use SymNext.

Syntax

BOOL IMAGEAPI SymGetSymNext(
  [in]      HANDLE           hProcess,
  [in, out] PIMAGEHLP_SYMBOL Symbol
);

Parameters

[in] hProcess

A handle to the process that was originally passed to the SymInitialize function.

[in, out] Symbol

A pointer to an IMAGEHLP_SYMBOL64 structure.

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

The SymGetSymNext64 function requires that the IMAGEHLP_SYMBOL64 structure have valid data, presumably obtained from a call to the SymGetSymFromAddr64 or SymGetSymFromName64 function. This structure is filled with the symbol information for the next symbol in sequence by virtual address.

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. SymGetSymNextW64 is defined as follows in DbgHelp.h.

BOOL
IMAGEAPI
SymGetSymNextW64(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_SYMBOLW64 Symbol
    );

This function supersedes the SymGetSymNext function. For more information, see Updated Platform Support. SymGetSymNext is defined as follows in DbgHelp.h.

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetSymNext SymGetSymNext64
#define SymGetSymNextW SymGetSymNextW64
#else
BOOL
IMAGEAPI
SymGetSymNext(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_SYMBOL Symbol
    );

BOOL
IMAGEAPI
SymGetSymNextW(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_SYMBOLW Symbol
    );
#endif

Requirements

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