На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

WaitForSingleObject



The WaitForSingleObject function returns when one of the following occurs:

· The specified object is in the signaled state.
· The time-out interval elapses.



DWORD WaitForSingleObject(

HANDLE hHandle, // handle of object to wait for
DWORD dwMilliseconds // time-out interval in milliseconds
);


Parameters

hHandle

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.

dwMilliseconds

Specifies the time-out interval, in milliseconds. The function returns if the interval elapses, even if the object's state is nonsignaled. If dwMilliseconds is zero, the function tests the object's state and returns immediately. If dwMilliseconds is INFINITE, the function's time-out interval never elapses.



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 WAIT_FAILED. To get extended error information, call GetLastError.
The return value on success is one of the following values:

Value Meaning
WAIT_ABANDONED 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.
WAIT_OBJECT_0 The state of the specified object is signaled.
WAIT_TIMEOUT The time-out interval elapsed, and the object's state is nonsignaled.


Remarks

The WaitForSingleObject function checks the current state of the specified object. If the object's state is nonsignaled, the calling thread enters an efficient wait state. The thread consumes very little processor time while waiting for the object state to become signaled or the time-out interval to elapse.
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 WaitForSingleObject function can wait for the following objects:

Object Description
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.
Event 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.
Mutex 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.
Process The CreateProcess or OpenProcess function returns the handle. A process object's state is signaled when the process terminates.
Semaphore 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.
Thread The CreateProcess, CreateThread, or CreateRemoteThread function returns the handle. A thread object's state is signaled when the thread terminates.
Timer 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.
You have to be careful when using the wait functions and DDE. If a thread creates any windows, it must process messages. DDE sends messages 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. Therefore, if you have a thread that creates windows, use MsgWaitForMultipleObjects or MsgWaitForMultipleObjectsEx, rather than WaitForSingleObject.

See Also

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


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

WaitForSingleObject



Функция WaitForSingleObject возвращается когда одно из следующего происходит:

Определенный объект - в сигнальном состоянии.
Интервал задержки истекает.



DWORD WaitForSingleObject(

РУЧКА hHandle, // ручка объекта против интервала задержки ожидания DWORD dwMilliseconds // в течение миллисекунд
);


Параметры

hHandle

Идентифицирует объект. Для списка объектных типов чьи ручки могут быть определены, смотри секцию Замечаний следующего.
Окно NT: ручка должна СИНХРОНИЗИРОВАТЬ доступ. Более подробно, видьте как Доступ Маскировал и Права Доступа.

dwMilliseconds

Определяет интервал задержки, в течение миллисекунд. Функция возвращается если интервал истекает, даже если бы объектное состояние nonsignaled. Если dwMilliseconds - нуль, функция тестирует объектное состояние и возвращает немедленно. Если dwMilliseconds БЕСКОНЕЧНЫЙ, функциональный интервал задержки никогда не истекает.



Обратные Величины

Если функция добивается успеха, обратная величина указывает случай, который заставлял функцию, чтобы возвращаться.
Если функция терпит неудачу, обратная величина - WAIT_FAILED. Для того, чтобы расширять информацию ошибки, назовите GetLastError.
Обратная величина в успехе - одно из следующего величин:

Значение Величины
WAIT_ABANDONED определенный объект - объект mutex, что не был выпущен резьбой, которая использовала объект mutex прежде, чем собственная резьба завершалась. Собственности на объект mutex предоставляют вызову резьбы, и mutex установлено на nonsignaled.
WAIT_OBJECT_0 состояние определенного объекта сигнализировано.
WAIT_TIMEOUT интервал задержки проходил, и объектное состояние nonsignaled.


Замечания

Функция WaitForSingleObject проверяет текущее состояние определенного объекта. Если объектное состояние nonsignaled, вызов резьбы вводит эффективное состояние ожидания. Резьба поглощает очень небольшое время процессора при ожидании объектного состояния, чтобы становиться сигнальным или интервалом задержки, чтобы истекать.
Перед возвратом, функция ожидания модифицирует состояние некоторых типов объектов синхронизации. Модификация происходит только для объекта или объекты чье сигнализировавшее, что состояние заставляло функцию, чтобы возвращаться. Например, счет объекта семафора уменьшен одним.

Функция WaitForSingleObject может подождать следующее объектов:

Описание Объекта
Уведомление Изменения функциональный возврат FindFirstChangeNotification ручка. Уведомление изменения объектного состояния сигнализировано когда определенный тип изменения происходит в пределах определенного дерева директория или директория.
Консоль вводится, ручка возвращана функцией CreateFile когда CONIN$ величина определена, или функцией GetStdHandle. Объектное состояние сигнализировано когда есть unread ввод в консольном входном буфере, и nonsignaled когда входной буфер пустой.
Событие CreateEvent или функциональный возврат OpenEvent ручка. Объектное состояние события устанавливается явно на сигнализированное SetEvent или функция PulseEvent. Руководство-восстановившее объектное состояние события должны восстанавливаться явно на nonsignaled функцией ResetEvent. Для авто-восстановившее объект события, функция ожидания сбрасывает объектное состояние на nonsignaled перед возвратом. Объекты События также использованы на перекрытых операциях, в которых состояние установлено системой.
Mutex CreateMutex Или функциональный возврат OpenMutex ручка. Объектное состояние mutex сигнализировано когда оно не принадлежащее любой резьбе. Функция ожидания запрашивает собственность на mutex для вызов резьба, изменяющую состояние mutex's на nonsignaled когда собственности предоставляют.
Обработайте CreateProcess или функциональному возврату OpenProcess ручку. Объектное состояние процесса сигнализировано когда процесс завершается.
Сигнализируйте CreateSemaphore или функциональному возврату OpenSemaphore ручку. Объект семафора поддерживает счет между нулевой и некоторой максимальной величиной. Состояние сигнализировано когда счет больше, чем нуль и nonsignaled когда счет нулевой. Если текущее состояние сигнализировано, функция ожидания уменьшает счет одной.
Заправьте CreateProcess, CreateThread, или функцию CreateRemoteThread возвращает ручку. Объектное состояние резьбы сигнализировано когда резьба завершается.
Таймер CreateWaitableTimer или функциональный возврат OpenWaitableTimer ручка. Активизируйте таймер вызывая функцию SetWaitableTimer. Состояние активного таймера сигнализировано когда оно достигает своего подлежащего времени. Вы можете деактивизировать таймер вызывая функцию CancelWaitableTimer. Состояние активного таймера сигнализировано когда оно достигает своего подлежащего времени. Вы можете деактивизировать таймер вызывая функцию CancelWaitableTimer.


В некоторых обстоятельствах, Вы можете определить ручку файла, назвавшего трубу, или устройство связи как объект синхронизации в lpHandles. Тем не менее, их использование с этой целью отговорено.
Вы должны быть осторожными при использовании функций ожидания и DDE. Если резьба создает любое окно, она должна обработать сообщения. DDE ПОСЫЛАЕТ сообщения во все окно в системе. Если у вас есть резьба, которая использует функцию ожидания без интервала задержки, система будет тупиком. Следовательно, если у вас есть резьба, которая создает окно, используйте MsgWaitForMultipleObjects или MsgWaitForMultipleObjectsEx, а не WaitForSingleObject.

Смотри Также

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


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz