Click or drag to resize

wclHelpersWaitEx(IntPtr, UInt32) Method

Waits until one or all of the specified objects are in the signaled state, an I/O completion routine or asynchronous procedure call (APC) is queued to the thread, or the time-out interval elapses.

Namespace: wclCommon
Assembly: wclCommon (in wclCommon.dll) Version: 7.11.10.0 (7.11.10.0)
Syntax
Copy
public static uint WaitEx(
	IntPtr[] Handles,
	uint Milliseconds
)

Parameters

Handles  IntPtr
An array of object handles.
Milliseconds  UInt32

The time interval for which execution is to be suspended, in milliseconds.

A value of zero causes the thread to relinquish the remainder of its time slice to any other thread that is ready to run. If there are no other threads ready to run, the function returns immediately, and the thread continues execution. Windows XP: A value of zero causes the thread to relinquish the remainder of its time slice to any other thread of equal priority that is ready to run. If there are no other threads of equal priority ready to run, the function returns immediately, and the thread continues execution. This behavior changed starting with Windows Server 2003.

A value of 0xFFFFFFFF indicates that the suspension should not time out.

Return Value

UInt32

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

Returning wclWinAPI.WAIT_IO_COMPLETION indicates that the wait was ended by one or more user-mode asynchronous procedure calls (APC) queued to the thread.

Returning Common.WAIT_TIMEOUT indicates that the time-out interval elapsed and no completion routines are queued.

Returning wclWinAPI.WAIT_FAILED indicates that the function has failed.

See Also