WaitForSingleObject

【勇芳软件工作室】汉化HomePreviousNext

当发生以下其中一种情况时,WaitForSingleObject函数返回:

*指定的对象处于信号状态。

*经过了超时间隔。

DWORD WaitForSingleObject(

HANDLE 【hHandle】,//处理对象等待
DWORD 【dwMilliseconds】//超时间隔(以毫秒为单位)
); 

参数

【hHandle】

标识对象。有关可以指定句柄的对象类型的列表,请参阅以下备注部分。

Windows NT:句柄必须具有SYNCHRONIZE访问权限。有关详细信息,请参阅访问掩码和访问权限.

【dwMilliseconds】

指定超时间隔(以毫秒为单位)。即使该对象的状态为非指定,该函数也将返回。如果【dwMilliseconds】为零,则该函数测试对象的状态并立即返回。如果【dwMilliseconds】为INFINITE,则该函数的超时间隔从不会过去。

返回值

如果函数成功,则返回值表示导致函数返回的事件。

如果函数失败,返回值为WAIT_FAILED。要获取扩展错误信息,请调用GetLastError.

成功的返回值是以下值之一:

含义
WAIT_ABANDONED指定的对象是一个互斥对象,该对象在所有线程终止之前未被拥有互斥对象的线程释放。互斥对象的所有权被授予调用线程,并且互斥体被设置为非指定的。
WAIT_OBJECT_0发出指定对象的状态。
WAIT_TIMEOUT超时间隔已经过去,对象的状态是非信号的。

备注

WaitForSingleObject函数检查指定对象的当前状态。如果对象的状态为非指定状态,则调用线程进入有效的等待状态。线程消耗很少的处理器时间,同时等待对象状态变为信号或超时间隔。

在返回之前,wait函数修改某些类型的同步对象的状态。修改仅针对信号状态导致功能返回的对象或对象。例如,信号量对象的计数减1。

WaitForSingleObject功能可以等待以下对象:

目的描述
更改通知enFindFirstChangeNotification函数返回句柄。当在指定的目录或目录树中发生指定类型的更改时,发出更改通知对象的状态。
控制台输入当指定CONIN $值时,由CreateFile函数返回句柄,或由GetStdHandle函数返回。当控制台的输入缓冲区中有未读的输入时,对象的状态发出信号,当输入缓冲区为空时,该状态为非信号。
事件CreateEventOpenEvent函数返回句柄。事件对象的状态被明确设置为由SetEventPulseEvent功能发出信号。手动复位事件对象的状态必须显式重置为ResetEvent功能的非指定状态。对于自动重置事件对象,等待功能在返回之前将对象的状态重置为非指定状态。事件对象也用于重叠操作,其中状态由系统设置。
互斥CreateMutexOpenMutex函数返回句柄。当互斥体对象的状态不被任何线程所拥有时发出。等待函数请求调用线程的互斥体的所有权,在授予所有权时将互斥体的状态更改为非指定状态。
处理CreateProcessOpenProcess函数返回句柄。进程对象的状态在进程终止时发出信号。
信号CreateSemaphoreOpenSemaphore函数返回句柄。信号量对象维持零和某个最大值之间的计数。当它的计数大于零时,它的状态被发出信号,当它的计数为零时,它的信号是非信号的。如果发出当前状态,则等待功能将计数减1。
线CreateProcessCreateThreadCreateRemoteThread函数返回句柄。当线程终止时,会发出线程对象的状态。
计时器CreateWaitableTimerOpenWaitableTimer函数返回句柄。通过调用SetWaitableTimer函数激活定时器。有效定时器的状态在达到适当的时间时发出信号。您可以通过调用CancelWaitableTimer功能来停用定时器。有效定时器的状态在达到适当的时间时发出信号。您可以通过调用CancelWaitableTimer功能来停用定时器。

在某些情况下,您可以在【lpHandles】中将名为管道或通讯设备的文件的句柄指定为同步对象。但是,不鼓励用于此目的。

使用等待功能和DDE时必须要小心。如果一个线程创建任何窗口,它必须处理消息。DDE向系统中的所有窗口发送消息。如果您的线程使用等待功能,没有超时间隔,系统将会死锁。因此,如果您有一个创建窗口的线程,请使用MsgWaitForMultipleObjectsMsgWaitForMultipleObjectsEx而不是WaitForSingleObject.

也可以看看

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