SymEnumSourceLines function (dbghelp.h)

Article
02/22/2024

Enumerates all source lines in a module.

Syntax

BOOL IMAGEAPI SymEnumSourceLines(
  [in]           HANDLE                  hProcess,
  [in]           ULONG64                 Base,
  [in, optional] PCSTR                   Obj,
  [in, optional] PCSTR                   File,
  [in, optional] DWORD                   Line,
  [in]           DWORD                   Flags,
  [in]           PSYM_ENUMLINES_CALLBACK EnumLinesCallback,
  [in, optional] PVOID                   UserContext
);

Parameters

[in] hProcess

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

[in] Base

The base address of the module.

[in, optional] Obj

The name of an .obj file within the module. The scope of the enumeration is limited to this file. If this parameter is NULL or an empty string, all .obj files are searched.

[in, optional] File

A wildcard expression that indicates the names of the source files to be searched. If this parameter is NULL or an empty string, all files are searched.

[in, optional] Line

The line number of a line within the module. The scope of the enumeration is limited to this line. If this parameter is 0, all lines are searched.

[in] Flags

If this parameter is ESLFLAG_FULLPATH, the function matches the full path in the File parameter.

[in] EnumLinesCallback

A SymEnumLinesProc callback function that receives the line information.

[in, optional] UserContext

A user-defined value that is passed to the callback function, or NULL. This parameter is typically used by an application to pass a pointer to a data structure that provides context for the callback function.

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.4 or later