Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 190 / 357

190 PICam™ 5.x Programmer’s Manual Issue 11
6.4.5
Picam_WaitForAcquisitionUpdate()
Description
Picam_WaitForAcquisitionUpdate()
is used in combination with
Picam_StartAcquisition()
and indicates when:
• New data are available; or
• The hardware’s status has changed.
Usage
Picam_WaitForAcquisitionUpdate()
must be continuously called until
PicamAcquisitionStatus
.
running
is
FALSE
. This is true regardless of any acquisition
errors that may be returned or if
Picam_StopAcquisition()
has been called.
Any errors returned during data acquisition are stored in
PicamAcquisitionStatus
.
errors
and acquisition will be halted.
However, if new data is not available within the time specified by
readout_time_out
:
• The
PicamError_TimeOutOccurred
error is returned;
• Data acquisition will continue; and
• The contents of both the data buffer
available
as well as the
status
data
structure are invalid.
Syntax
The syntax for
Picam_WaitForAcquisitionUpdate()
is:
PICAM_API Picam_WaitForAcquisitionUpdate(
PicamHandle camera,
piint readout_time_out,
PicamAvailableData* available,
PicamAcquisitionStatus* status);
Input Parameters
Input parameters for
Picam_WaitForAcquisitionUpdate()
are:
Output Parameters
Output parameters for
Picam_WaitForAcquisitionUpdate()
are:
continued on next page
camera:
Handle for the hardware from which data is being acquired.
readout_time_out: The time, in mS, to wait between each successive readout.
To configure this function to wait forever until a change occurs, set
this parameter to -1.
available: The output buffer used to store newly acquired data from the
specified hardware.
Data stored in this buffer is valid until the next
Picam_WaitForAcquisitionUpdate() call.
status:
Pointer to the
PicamAcquisitionStatus
data structure in which
acquisition status information is stored.