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

Page: 188 / 357

188 PICam™ 5.x Programmer’s Manual Issue 11
6.4.3
Picam_StopAcquisition()
Description
Picam_StopAcquisition()
asynchronously requests an in-progress data acquisition
to halt and returns immediately.
On success, the data acquisition will stop running sometime in the future after this
function returns.
The acquisition is stopped when
Picam_IsAcquisitionRunning()
returns FALSE or
PicamAcquisitionStatus
.
running
is FALSE.
NOTE:
[Advanced API Usage ONLY]
If
PicamParameter_ReadoutCount
= 0, the hardware will
run continuously until
Picam_StopAcquisition()
has
been called.
Syntax
The syntax for
Picam_StopAcquisition()
is:
PICAM_API Picam_StopAcquisition(
PicamHandle camera);
Input Parameters
Input parameters for
Picam_StopAcquisition()
are:
Output Parameters
There are no output parameters associated with
Picam_StopAcquisition()
.
Related APIs
For additional information, refer to the following related APIs:
• Picam_StartAcquisition() .
• Picam_IsAcquisitionRunning() .
•
Picam_WaitForAcquisitionUpdate()
.
camera:
Handle for the hardware for which data acquisition is to be halted.