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

Page: 179 / 357

Chapter 5 Configuration APIs 179
5.4.6.2 Picam_CommitParameters()
Description
Picam_CommitParameters()
validates parameter values and applies these valid
values to the specified hardware during system setup and configuration.
• Any parameter that fails to satisfy its required constraint(s) is flagged as invalid
and is stored within
failed_parameter_array
.
• The number of invalid parameters is stored in
failed_parameter_count
. If no
invalid parameters are detected, this value is 0.
Syntax
The syntax for
Picam_CommitParameters()
is:
PICAM_API Picam_CommitParameters(
PicamHandle camera_or_accessory,
const PicamParameter** failed_parameter_array,
piint* failed_parameter_count);
Input Parameters
Input parameters for
Picam_CommitParameters()
are:
Output Parameters
Output parameters for
Picam_CommitParameters()
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
.
Picam_CommitParameters()
systematically configures
device
with (valid) parameter
values that have been stored in
model
.
camera_or_accessory:
Handle for the hardware for which parameter values are being
configured.
failed_parameter_array:
Pointer to the allocated array in which the list of failed/invalid
parameters is stored.
If no invalid parameters are detected, this is a null object.
NOTE: This memory is allocated by PICam and must be
released by calling
Picam_DestroyParameters() .
failed_parameter_count:
Pointer to the memory location in which the number of
failed/invalid parameters is stored.