SymEnumSourceLines Function
Enumerates all source lines in a module.
BOOL WINAPI SymEnumSourceLines( __in HANDLE hProcess, __in ULONG64 Base, __in PCTSTR Obj, __in PCTSTR File, __in DWORD Line, __in DWORD Flags, __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
-
The 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.
- 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.
- Flags
-
If this parameter is ESLFLAG_FULLPATH, the function matches the full path in the File parameter.
- 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
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
Redistributable |
Requires DbgHelp.dll 6.4 or later. |
---|---|
Header |
Declared in DbgHelp.h. |
Library |
Use Dbghelp.lib. |
DLL |
Requires Dbghelp.dll. |
Unicode |
Implemented as SymEnumSourceLinesW (Unicode) and SymEnumSourceLines (ANSI). |
See Also
DbgHelp FunctionsSymEnumLinesProc
SymInitialize
Send comments about this topic to Microsoft
Build date: 9/25/2007
© 2007 Microsoft Corporation. All rights reserved.