-->
Waits until the specified object is in the signaled state or the time-out interval elapses.
Whose for Inanimate Objects “Whose” sounds most natural when it’s used for animate objects, like people and animals, and other things that breathe and possess the life force. Apparently there are folks out there who share the opinion that “whose” for inanimate objects shouldn’t be used because it sounds weird.
To enter an alertable wait state, use theWaitForSingleObjectEx function. To wait for multiple objects, useWaitForMultipleObjects.
Syntax
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.
The handle must have the SYNCHRONIZE access right. For more information, seeStandard Access Rights.
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.
Windows XP, Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 and Windows Server 2008 R2: The dwMilliseconds value does include time spent in low-power states. For example, the timeout does keep counting down while the computer is asleep.
Windows 8, Windows Server 2012, Windows 8.1, Windows Server 2012 R2, Windows 10 and Windows Server 2016: The dwMilliseconds value does not include time spent in low-power states. For example, the timeout does not keep counting down while the computer is asleep.
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.
Return code/value | Description |
---|---|
| 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. |
| The state of the specified object is signaled. |
| The time-out interval elapsed, and the object's state is nonsignaled. |
| The function has failed. To get extended error information, call GetLastError. |
Remarks
TheWaitForSingleObject 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.
TheWaitForSingleObject function can wait for the following objects:
- Change notification
- Console input
- Event
- Memory resource notification
- Mutex
- Process
- Semaphore
- Thread
- Waitable timer
Examples
For an example, seeUsing Mutex Objects.
Requirements
Minimum supported client | Windows XP [desktop apps | UWP apps] |
Minimum supported server | Windows Server 2003 [desktop apps | UWP apps] |
Target Platform | Windows |
Header | synchapi.h (include Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2, Windows.h) |
Library | Kernel32.lib |
DLL | Kernel32.dll |
See Also
Clause Position
Modifying the Subject of the Main Clause
SUBJECT of MOD CLS MODIFIES SUBJECT OF MAIN CLAUSE | ||
---|---|---|
Below, whose+ a clause modifies the subject noun of the main clause. Whose+noun has taken the place of the subject pronoun in the modifying clause. | ||
The man is a doctor.His showis entertaining. The doctor is successful.His adviceis amusing. | ||
SUBJECT | SUBJECT of MOD CLS | |
The man | whoseshow is entertaining subject–verb–adjective | is a doctor. |
The doctor | whose advice is amusing | is successful on TV. |
OBJECT of MOD CLS MODIFIES SUBJECT OF MAIN CLAUSE | ||
---|---|---|
Below, that + a clause modifies the subject noun of the main clause. That has taken the place of the object pronoun in the modifying clause. | ||
The man is a doctor.We watch his show. The doctor is successful.We valuehis advice . | ||
SUBJECT | SUBJECT of MOD CLS | |
The man | whose show we watch object–subject–verb | is a doctor. |
The doctor | whose advice we value | is successful on TV. |
complement – a word, phrase or clause which is necessary in a sentence to complete its meaning
verb + complement – elements required to complete the meaning of the clause
verb + complement – elements required to complete the meaning of the clause
Modifying the Object of the Main Clause
MODIFIES OBJECT OF MAIN CLAUSE | ||
---|---|---|
Below, whose + a clause modifies the object noun of the main clause. whose is the subject pronoun in the modifying clause. | ||
We watch the doctor.His TV showis funny. Do you know the talk show host.His nameis Turkish? | ||
OBJECT | OBJECT of MOD CLS | |
We watch | the doctor | whoseTV show is funny subject–verb–adjective |
Do you know | the talk show host | whosenameis Turkish? |
MODIFIES OBJECT OF MAIN CLAUSE | ||
---|---|---|
Below, that + a clause modifies the object noun of the main clause. That is also the object pronoun in the modifying clause. | ||
We watch the doctor.You likehis TV show. The doctor is successful.We valuehis advice. | ||
OBJECT | OBJECT of MOD CLS | |
We watch | the doctor | whose TV showyou like. object–subject–verb |
Do you know | the talk show host | whosenamei can't remember? |
tiny (Adj)– very small
tryout (V) – test drive
Related pages: That vs. Which using commas | Who / Whom using that for people