Home > C: Programming > Function descriptions > History back  Previous chapter  Next chapter  Print  

is_WaitEvent

uEye Camera Manual Version 4.00

is_WaitEvent

Windows_Logo

Linux_Logo

-

USB 2.0

USB 3.0

GigE

Syntax

INT is_WaitEvent (HIDS hCam, INT which, INT nTimeout)

Description

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 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

is_EnableEvent()

is_DisableEvent()

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 signalled */

}

is_DisableEvent(hCam, IS_SET_EVENT_FRAME);


Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.


© 2012 IDS Imaging Development Systems GmbH
http://www.ids-imaging.com