User`s guide

FUNCTIONS

SDK SECTION 11

Page 262

WaitForAcquisitionByHandleTimeOut

unsigned int WINAPI WaitForAcquisitionByHandleTimeOut (long cameraHandle, int iTimeOutMs)

Description

Whilst using multiple cameras WaitForAcquisitionByHandle can be called after an

acquisition is started using

StartAcquisition to put the calling thread to sleep until an

Acquisition Event occurs. This can be used as a simple alternative to the functionality

provided by the SetDriverEvent function, as all Event creation and handling is performed

internally by the SDK library. Like the SetDriverEvent functionality it will use less processor

resources than continuously polling with the GetStatus function. If you wish to restart the

calling thread without waiting for an Acquisition event, call the function CancelWait. An

Acquisition Event occurs each time a new image is acquired during an Accumulation,

Kinetic Series or Run-Till-Abort acquisition or at the end of a Single Scan Acquisition. If an

Acquisition Event does not occur within _TimeOutMs milliseconds,

WaitForAcquisitionTimeOut returns DRV_NO_NEW_DATA

Parameters

Long cameraHandle: handle of camera to put into wait state.

int iTimeOutMs: Time before returning DRV_NO_NEW_DATA if no Acquisition Event

occurs.

Return

unsigned int

DRV_SUCCESS

DRV_P1INVALID

DRV_NO_NEW_DATA

Acquisition Event occurred.

Handle not valid.

Non-Acquisition Event occurred.(eg CancelWait () called, time out)