Serial Framework C++ Edition

◆ Wait() [2/4]

static int Wait ( const unsigned long  Count,
const HANDLE *  Events,
const unsigned long  Timeout,
unsigned long &  Index 
)
static

Waits until one or all of the specified objects are in the signaled state or the time-out interval elapses.

Parameters
CountThe number of object handles in the array pointed to by Events. The maximum number of object handles is 64.
EventsAn array of object handles.
TimeoutThe time-out interval, in milliseconds. If a nonzero value is specified, the function waits until the event is signaled or the interval elapses. If Timeout is zero, the function does not enter a wait state if the event is not signaled; it always returns immediately. If Timeout is INFINITE, the function will return only when the event is signaled.
IndexIf the function completed with success on output contains the index of the signaled object.
Returns
If the function succeed the returns value is WCL_E_SUCCESS. Otherwise the function returns one of the WCL error codes.