This function takes a snapshot of the processes and the heaps, modules, and threads used by the processes.
At a Glance
| Header file: | Tlhelp32.h |
| Windows CE versions: | 2.0 and later |
Syntax
HANDLE WINAPI CreateToolhelp32Snapshot( DWORD dwFlags,
DWORD th32ProcessID);
Parameters
dwFlags
Specifies portions of the system to include in the snapshot. This parameter can be one of the following:
| Value | Description |
| TH32CS_SNAPALL | Equivalent to specifying TH32CS_SNAPHEAPLIST, TH32CS_SNAPMODULE, TH32CS_SNAPPROCESS, and TH32CS_SNAPTHREAD. |
| TH32CS_SNAPHEAPLIST | Includes the heap list of the specified process in the snapshot. |
| TH32CS_SNAPMODULE | Includes the module list of the specified process in the snapshot. |
| TH32CS_SNAPPROCESS | Includes the process list in the snapshot. |
| TH32CS_SNAPTHREAD | Includes the thread list in the snapshot. |
| THCS_GETALLMODES | Returns a list of all the modules loaded in the system. |
th32ProcessID
Process identifier. This parameter can be zero to indicate the current process. This parameter is used when the TH32CS_SNAPHEAPLIST or TH32CS_SNAPMODULE value is specified. Otherwise, it is ignored.
Return Value
An open handle to the specified snapshot indicates success. – 1 indicates failure.
Remarks
The snapshot returned is a copy of the current state of the system. To close a snapshot call the CloseToolhelp32Snapshot function.
The snapshot taken by this function is examined by the other tool help functions to provide their results. Access to the snapshot is read only. The snapshot handle acts like an object handle and is subject to the same rules regarding which processes and threads it is valid in.
To retrieve an extended error status code generated by this function, use the GetLastError function.
See Also