Retrieves information about the first process encountered in a system snapshot.
Syntax
BOOL WINAPI Process32First(
__in HANDLE hSnapshot,
__inout LPPROCESSENTRY32 lppe
);
Parameters
- hSnapshot [in]
-
A handle to the snapshot returned from a previous call to the
CreateToolhelp32Snapshot function.
- lppe [in, out]
-
A pointer to a
PROCESSENTRY32 structure. It contains process information such as the name of the executable file, the process identifier, and the process identifier of the parent process.
Return Value
Returns TRUE if the first entry of the process list has been copied to the buffer or FALSE otherwise. The ERROR_NO_MORE_FILES error value is returned by the
GetLastError function if no processes exist or the snapshot does not contain process information.
Remarks
The calling application must set the dwSize member of
PROCESSENTRY32 to the size, in bytes, of the structure.
To retrieve information about other processes recorded in the same snapshot, use the
Process32Next function.
Examples
For an example, see
Taking a Snapshot and Viewing Processes.
Requirements
Minimum supported client | Windows 2000 Professional |
Minimum supported server | Windows 2000 Server |
Header | Tlhelp32.h |
Library | Kernel32.lib |
DLL | Kernel32.dll |
Unicode and ANSI names | Process32FirstW (Unicode) and Process32First (ANSI) |
See Also
- CreateToolhelp32Snapshot
- Process Walking
- Process32Next
- PROCESSENTRY32
- Tool Help Functions
Send comments about this topic to Microsoft
Build date: 2/4/2010