WaitForSingleObject
The WaitForSingleObject function waits until the specified object is in the signaled state or the time-out interval elapses.
Syntax
DWORD WaitForSingleObject( HANDLE hHandle, DWORD dwMilliseconds , );
Parameters
hHandle
A handle to the object. For a list of the object types whose handles can be specified, see the following Remarks section.
If this handle is closed while the wait is still pending, the function's behavior is undefined.
dwMilliseconds
The time-out interval, in milliseconds. If a nonzero value is specified, the function waits until the object is signaled or the interval elapses. If dwMilliseconds is zero, the function does not enter a wait state if the object is not signaled; it always returns immediately. If dwMilliseconds is INFINITE, the function will return only when the object is signaled.
Return Value
If the function succeeds, the return value indicates the event that caused the function to return. It can be one of the following values.
| Value | Meaning |
|---|---|
|
WAIT_ABANDONED 0x00000080L |
The specified object is a mutex object that was not released by the thread that owned the mutex object before the owning thread terminated. Ownership of the mutex object is granted to the calling thread and the mutex state is set to nonsignaled. If the mutex was protecting persistent state information, you should check it for consistency. |
|
WAIT_OBJECT_0 0x00000000L |
The state of the specified object is signaled. |
|
WAIT_TIMEOUT 0x00000102L |
The time-out interval elapsed, and the object's state is nonsignaled. |
|
WAIT_FAILED (DWORD) 0xFFFFFFFF |
The function has failed. To get extended error information, call GetLastError. |
Remarks
The WaitForSingleObject function checks the current state of the specified object. If the object's state is nonsignaled, the calling thread enters the wait state until the object is signaled or the time-out interval elapses.
The function modifies the state of some types of synchronization objects. Modification occurs only for the object whose signaled state caused the function to return. For example, the count of a semaphore object is decreased by one.
The WaitForSingleObject function can wait for the following objects:
- Change notification (not in RTSS)
- Console input (not in RTSS)
- Event
- Memory resource notification (not in RTSS)
- Mutex
- Process
- Semaphore
- Thread
- Waitable timer (not in RTSS)
Requirements
| Minimum Supported Version | RTX64 2013 |
| Header | windows.h |
| Library | Rtx_Rtss.lib |
