WaitForSingleObject
E724279
WaitForSingleObject is a Windows API synchronization function that blocks a thread until a specified object is signaled or a timeout interval elapses.
Statements (48)
| Predicate | Object |
|---|---|
| instanceOf |
Windows API function
ⓘ
synchronization function ⓘ |
| alertableWait | false ⓘ |
| appliesTo | user-mode threads ⓘ |
| asynchronousAlternative | RegisterWaitForSingleObject NERFINISHED ⓘ |
| belongsToLibrary | Win32 API NERFINISHED ⓘ |
| callingConvention | stdcall ⓘ |
| definedInHeader | windows.h ⓘ |
| errorRetrievalFunction | GetLastError ⓘ |
| introducedIn | early versions of Win32 ⓘ |
| languageBinding |
C
ⓘ
C++ ⓘ |
| library | Kernel32.dll NERFINISHED ⓘ |
| managedWrapper | System.Threading.WaitHandle.WaitOne in .NET ⓘ |
| multiObjectAlternative | WaitForMultipleObjects NERFINISHED ⓘ |
| multiObjectWaitSupport | false ⓘ |
| operatingSystem |
Windows
ⓘ
surface form:
Microsoft Windows
|
| parameter |
DWORD dwMilliseconds
ⓘ
HANDLE hHandle ⓘ |
| purpose | waits until a specified object is in the signaled state or a timeout interval elapses ⓘ |
| returnType | DWORD ⓘ |
| returnValue |
WAIT_ABANDONED
ⓘ
WAIT_FAILED ⓘ WAIT_OBJECT_0 ⓘ WAIT_TIMEOUT ⓘ |
| returnValueMeaning |
the function failed
ⓘ
the specified object is signaled ⓘ the time-out interval elapsed ⓘ the wait was satisfied by an abandoned mutex object ⓘ |
| supportsTimeout | true ⓘ |
| synchronizationModel | kernel-mode synchronization ⓘ |
| synchronizationScope | single waitable object ⓘ |
| threadBlocking | blocks the calling thread ⓘ |
| timeoutSpecialValue | INFINITE ⓘ |
| timeoutSpecialValueMeaning | waits indefinitely ⓘ |
| timeoutUnit | milliseconds ⓘ |
| usagePattern |
used to implement thread synchronization
ⓘ
used to wait for process termination ⓘ used to wait for thread completion ⓘ |
| waitableObjectType |
change notification handle
ⓘ
console input handle ⓘ event object ⓘ job object handle ⓘ mutex object ⓘ process handle ⓘ semaphore object ⓘ thread handle ⓘ waitable timer ⓘ |
Referenced by (1)
Full triples — surface form annotated when it differs from this entity's canonical label.