 |
 |
|---|---|
- |
USB 2.0 USB 3.x GigE |
Syntax
INT is_WaitEvent (HIDS hCam, INT which, INT nTimeout)
Description
|
This function is obsolete and should not be used anymore. We recommend to use the is_Event() function instead. |
is_WaitEvent() allows waiting for uEye events. The function indicates successful execution when the event has occurred within the specified timeout.
Input parameters
hCam |
Camera handle |
which |
ID of the event (see is_EnableEvent()) |
nTimeout |
Time in milliseconds (ms) that the function will wait for an event to occur. Using the constant INFINITE you can set the time for the timeout to infinity. |
Return values
IS_NO_SUCCESS |
General error message |
IS_SUCCESS |
Function executed successfully |
IS_TIMED_OUT |
A timeout occurred. An image capturing process could not be terminated within the allowable period. That means the specified timeout expired without the event having occurred. |
Related functions
Example
//Activate and initialize FRAME event
is_EnableEvent(hCam, IS_SET_EVENT_FRAME);
//Start image capture and wait 1000 ms for event to occur
is_FreezeVideo(hCam, IS_DONT_WAIT);
INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000);
if (nRet == IS_TIMED_OUT)
{
/* wait timed out */
}
else if (nRet == IS_SUCCESS)
{
/* event signaled */
}
is_DisableEvent(hCam, IS_SET_EVENT_FRAME);
