please dont rip this site Prev Next

WaitForSingleObjectEx info  Overview  Group

The WaitForSingleObjectEx function returns when one of the following occurs:

    HANDLE hHandle,

// handle of object to wait for

    DWORD dwMilliseconds,

// time-out interval in milliseconds

    BOOL bAlertable 

// return to execute I/O completion routine if TRUE



Identifies the object. For a list of the object types whose handles can be specified, see the following Remarks section.

Windows NT: The handle must have SYNCHRONIZE access. For more information, see Access Masks and Access Rights.

Specifies the time-out interval, in milliseconds. The function returns if the interval elapses, even if the objectís state is nonsignaled and no completion routines or APCs are queued. If dwMilliseconds is zero, the function tests the objectís state and checks for queued completion routines or APCs and then returns immediately. If dwMilliseconds is INFINITE, the functionís time-out interval never elapses.
Specifies whether the function returns when the system queues an I/O completion routine or APC. If TRUE, the function returns and the completion routine or APC function is executed. If FALSE, the function does not return, and the completion routine or APC function is not executed.

A completion routine is queued when the ReadFileEx or WriteFileEx function in which it was specified has completed. The wait function returns and the completion routine is called only if bAlertable is TRUE, and the calling thread is the thread that initiated the read or write operation. An APC is queued when you call QueueUserAPC.

Return Values

If the function succeeds, the return value indicates the event that caused the function to return.

If the function fails, the return value is 0xFFFFFFFF. To get extended error information, call GetLastError.

The successful return value is one of the following:




The state of the specified object is signaled.


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 is set to nonsignaled.


One or more I/O completion routines are queued for execution.


The time-out interval elapsed, and the objectís state is nonsignaled.


The WaitForSingleObjectEx function determines whether the wait criteria have been met. If the criteria have not been met, the calling thread enters an efficient wait state, consuming very little processor time while waiting for the criteria to be met.

Before returning, a wait function modifies the state of some types of synchronization objects. Modification occurs only for the object or objects whose signaled state caused the function to return. For example, the count of a semaphore object is decreased by one.

The WaitForSingleObjectEx function can wait for the following objects:



Change notification

The FindFirstChangeNotification function returns the handle. A change notification objectís state is signaled when a specified type of change occurs within a specified directory or directory tree.

Console input

The handle is returned by the CreateFile function when the CONIN$ value is specified, or by the GetStdHandle function. The objectís state is signaled when there is unread input in the consoleís input buffer, and it is nonsignaled when the input buffer is empty.


The CreateEvent or OpenEvent function returns the handle. An event objectís state is set explicitly to signaled by the SetEvent or PulseEvent function. A manual-reset event objectís state must be reset explicitly to nonsignaled by the ResetEvent function. For an auto-reset event object, the wait function resets the objectís state to nonsignaled before returning. Event objects are also used in overlapped operations, in which the state is set by the system.


The CreateMutex or OpenMutex function returns the handle. A mutex objectís state is signaled when it is not owned by any thread. The wait function requests ownership of the mutex for the calling thread, changing the mutexís state to nonsignaled when ownership is granted.


The CreateProcess or OpenProcess function returns the handle. A process objectís state is signaled when the process terminates.


The CreateSemaphore or OpenSemaphore function returns the handle. A semaphore object maintains a count between zero and some maximum value. Its state is signaled when its count is greater than zero and nonsignaled when its count is zero. If the current state is signaled, the wait function decreases the count by one.


The CreateProcess, CreateThread, or CreateRemoteThread function returns the handle. A thread objectís state is signaled when the thread terminates.


The CreateWaitableTimer or OpenWaitableTimer function returns the handle. Activate the timer by calling the SetWaitableTimer function. The state of an active timer is signaled when it reaches its due time. You can deactivate the timer by calling the CancelWaitableTimer function. The state of an active timer is signaled when it reaches its due time. You can deactivate the timer by calling the CancelWaitableTimer function.

In some circumstances, you can specify a handle of a file, named pipe, or communications device as a synchronization object in lpHandles. However, their use for this purpose is discouraged.

Wait Functions and Creating Windows

You have to be careful when using the wait functions and code that directly or indirectly creates windows. If a thread creates any windows, it must process messages. Message broadcasts are sent to all windows in the system. If you have a thread that uses a wait function with no time-out interval, the system will deadlock. Two examples of code that indirectly creates windows are DDE and COM CoInitialize. Therefore, if you have a thread that creates windows, use MsgWaitForMultipleObjects or MsgWaitForMultipleObjectsEx, rather than WaitForSingleObjectEx.

See Also

CancelWaitableTimer, CreateEvent, CreateFile, CreateMutex, CreateProcess, CreateRemoteThread, CreateSemaphore, CreateThread, CreateWaitableTimer, FindFirstChangeNotification, GetStdHandle, MsgWaitForMultipleObjects, MsgWaitForMultipleObjectsEx, OpenEvent, OpenMutex, OpenProcess, OpenSemaphore, OpenWaitableTimer, PulseEvent, QueueUserAPC, ReadFileEx, ResetEvent, SetEvent, SetWaitableTimer, WriteFileEx

file: /Techref/os/win/api/win32/func/src/f91_6.htm, 12KB, , updated: 2008/6/10 20:04, local time: 2023/6/1 23:12,

 ©2023 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions?
Please DO link to this page! Digg it! / MAKE!

<A HREF=""> WaitForSingleObjectEx</A>

After you find an appropriate page, you are invited to your to this massmind site! (posts will be visible only to you before review) Just type a nice message (short messages are blocked as spam) in the box and press the Post button. (HTML welcomed, but not the <A tag: Instead, use the link box to link to another page. A tutorial is available Members can login to post directly, become page editors, and be credited for their posts.

Link? Put it here: 
if you want a response, please enter your email address: 
Attn spammers: All posts are reviewed before being made visible to anyone other than the poster.
Did you find what you needed?

  PICList 2023 contributors:
o List host: MIT, Site host, Top posters @none found
- Page Editors: James Newton, David Cary, and YOU!
* Roman Black of Black Robotics donates from sales of Linistep stepper controller kits.
* Ashley Roll of Digital Nemesis donates from sales of RCL-1 RS232 to TTL converters.
* Monthly Subscribers: Gregg Rew. on-going support is MOST appreciated!
* Contributors: Richard Seriani, Sr.

Welcome to!