SymGetLineNext function (dbghelp.h)

Retrieves the line information for the next source line.

Syntax

BOOL IMAGEAPI SymGetLineNext(
  [in]      HANDLE         hProcess,
  [in, out] PIMAGEHLP_LINE Line
);

Parameters

[in] hProcess

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

[in, out] Line

A pointer to an IMAGEHLP_LINE64 structure that contains the line information.

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 SymGetLineNext64 function requires that the IMAGEHLP_LINE64 structure have valid data, presumably obtained from a call to the SymGetLineFromAddr64 or SymGetLineFromName64 function. This structure receives the line information for the next line in sequence.

This function returns a pointer to a buffer that may be reused by another function. Therefore, be sure to copy the data returned to another buffer immediately.

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. SymGetLineNextW64 is defined as follows in Dbghelp.h.


BOOL
IMAGEAPI
SymGetLineNextW64(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_LINEW64 Line

#ifdef DBGHELP_TRANSLATE_TCHAR
#define SymGetLineNext64  SymGetLineNextW64
#endif

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

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymGetLineNext SymGetLineNext64
#else
BOOL
IMAGEAPI
SymGetLineNext(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_LINE Line
    );

BOOL
IMAGEAPI
SymGetLineNextW(
    __in HANDLE hProcess,
    __inout PIMAGEHLP_LINEW Line
    );
#endif

Requirements

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

See also

DbgHelp Functions

IMAGEHLP_LINE64

SymGetLineFromAddr64

SymGetLineFromName64

SymGetLinePrev64

SymInitialize