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

Page: 178 / 357

178 PICam™ 5.x Programmer’s Manual Issue 11
5.4.6 Shared Camera/Accessory Parameter Commitment APIs
This section provides programming information about APIs used to commit parameter
values.
NOTE:
Accessories are always considered committed since any
changes to their parameters are applied directly to the
hardware.
5.4.6.1 Picam_AreParametersCommitted()
Description
Picam_AreParametersCommitted()
determines if the parameter configuration
changes have been applied to the specified hardware.
Syntax
The syntax for
Picam_AreParametersCommitted()
is:
PICAM_API Picam_AreParametersCommitted(
PicamHandle camera_or_accessory,
pibln* committed);
Input Parameters
Input parameters for
Picam_AreParametersCommitted()
are:
Output Parameters
Output parameters for
Picam_AreParametersCommitted()
are:
Advanced API Usage
When used in conjunction with Advanced APIs, if
camera_or_accessory
is a camera
handle, it may be a handle to either the:
•
device
, or
•
model
.
camera_or_accessory: Handle for the hardware for which parameter configuration
status information is being determined.
committed: Pointer to the test results. Indicates if parameter configuration
changes have been committed to the specified hardware.
Valid values are:
• TRUE
Indicates that parameter configuration changes have been
committed to the specified hardware.
• FALSE
Indicates that parameter configuration changes have not
been committed to the specified hardware.