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

Page: 144 / 357

144 PICam™ 5.x Programmer’s Manual Issue 11
5.4.2.3 Picam_SetParameterIntegerValue()
Description
Picam_SetParameterIntegerValue()
sets a parameter to a specified integer value
during hardware setup.
Syntax
The syntax for
Picam_SetParameterIntegerValue()
is:
PICAM_API Picam_SetParameterIntegerValue(
PicamHandle camera_or_accessory,
PicamParameter parameter,
piint value);
Input Parameters
Input parameters for
Picam_SetParameterIntegerValue()
are:
Output Parameters
There are no output parameters associated with
Picam_SetParameterIntegerValue()
.
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:
•
model
;
The
model
parameter may be set independently from the corresponding
device
parameter. However, doing so requires that all parameters be committed to the
device
prior to starting any data acquisition by calling
Picam_CommitParameters()
.
•
device
.
Setting a
device
parameter automatically sets the corresponding
model
parameter to the same value.
Related APIs
For additional information, refer to the following related APIs:
• Picam_CommitParameters() .
camera_or_accessory:
Handle for the hardware being configured.
parameter: Specifies the parameter that is to be set with an integer value.
Valid parameters are those of type:
• PicamValueType_Integer ;
• PicamValueType_Boolean
;
• PicamValueType_Enumeration
.
value:
The integer value to which the parameter is to be set.