SymEnumLines Function

Enumerates all lines in the specified module.

BOOL WINAPI SymEnumLines(
  __in          HANDLE hProcess,
  __in          ULONG64 Base,
  __in          PCTSTR Obj,
  __in          PCTSTR File,
  __in          PSYM_ENUMLINES_CALLBACK EnumLinesCallback,
  __in          PVOID UserContext
);

Parameters

hProcess

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

Base

The base address of the module.

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.

File

A regular 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.

EnumLinesCallback

A SymEnumLinesProc callback function that receives the line information.

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

This function is supported for PDB information only. If you have COFF information, try using one of the SymGetLineXXX functions.

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

Redistributable	Requires DbgHelp.dll 6.1 or later.
Header	Declared in Dbghelp.h.
Library	Use Dbghelp.lib.
DLL	Requires Dbghelp.dll.
Unicode	Implemented as SymEnumLinesW (Unicode) and SymEnumLines (ANSI).

See Also

DbgHelp FunctionsSymEnumLinesProc

Send comments about this topic to Microsoft

Build date: 9/25/2007