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

Page: 176 / 357

176 PICam™ 5.x Programmer’s Manual Issue 11
5.4.5.3 Picam_GetParameterCollectionConstraint()
Description
Picam_GetParameterCollectionConstraint()
returns constraint information for
a specified constraint category and parameter combination.
Syntax
The syntax for
Picam_GetParameterCollectionConstraint()
is:
PICAM_API Picam_GetParameterCollectionConstraint(
PicamHandle camera_or_accessory,
PicamParameter parameter,
PicamConstraintCategory category,
const PicamCollectionConstraint** constraint);
Input Parameters
Input parameters for
Picam_GetParameterCollectionConstraint()
are:
Output Parameters
Output parameters for
Picam_GetParameterCollectionConstraint()
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
.
Related APIs
For additional information, refer to the following related APIs:
•
Picam_DestroyCollectionConstraints()
.
Related Structures
For additional information, refer to the following parameter structures:
• PicamParameter ;
•
PicamCollectionConstraint
.
camera_or_accessory: Handle for the hardware for which constraint information is being
returned.
parameter: Specifies the parameter for which constraint information is being
requested.
category: Specifies the constraint category for which the list of constraints
is being requested.
constraint: Pointer to the allocated array in which the list of constraints
available for the specified constraint category and parameter
combination is stored.
NOTE: This memory is allocated by PICam and must be released
by calling
Picam_DestroyCollectionConstraints()
.