Serial Framework C++ Edition

◆ Wait() [4/4]

static int Wait ( HANDLE  Event,
unsigned long  Timeout 
)
static

Waits until the specified event is in the signaled state or the time-out interval elapses.

Parameters
EventA handle to the event.
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.
Returns
If the function succeed the returns value is WCL_E_SUCCESS. Otherwise the function returns one of the WCL error codes.