 Important: |
|---|
| This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. |
This function suspends the specified thread.
DWORD SuspendThread( HANDLE hThread );
Parameters
- hThread
- Handle to the thread.
Return Values
The thread's previous suspend count indicates success. 0xFFFFFFFF indicates failure. To get extended error information, call GetLastError.
Remarks
If the function succeeds, execution of the specified thread is suspended and the thread's suspend count is incremented.
Suspending a thread causes the thread to stop executing user-mode (application) code.
If the thread is making a kernel call, SuspendThreadfails. An application may need to repeat the SuspendThreadseveral times for it to succeed.
Each thread has a suspend count (with a maximum value of MAXIMUM_SUSPEND_COUNT). If the suspend count is greater than zero, the thread is suspended; otherwise, the thread is not suspended and is eligible for execution. Calling SuspendThreadcauses the target thread's suspend count to be incremented. Attempting to increment past the maximum suspend count causes an error without incrementing the count.
The ResumeThreadfunction decrements the suspend count of a suspended thread.
Requirements
Runs on Versions Defined in Include Link to Windows CE OS 1.0 and later Winbase.h Coredll.lib Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.
See Also