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

Page: 139 / 357

Chapter 5 Configuration APIs 139
5.4.1.20 Picam_SetParameterIntegerValueOnline()
Description
Picam_SetParameterIntegerValueOnline()
configures the specified parameter
with an integer value during data acquisition.
NOTE:
The specified parameter must be capable of being
configured during data acquisition.
Refer to
Picam_CanSetParameterOnline()
for additional
information.
Syntax
The syntax for
Picam_SetParameterIntegerValueOnline()
is:
PICAM_API Picam_SetParameterIntegerValueOnline(
PicamHandle camera,
PicamParameter parameter,
piint value);
Input Parameters
Input parameters for
Picam_SetParameterIntegerValueOnline()
are:
Advanced API Usage
When used in conjunction with Advanced APIs,
camera
may be a handle to either the:
•
device
, or
•
model
.
Picam_SetParameterIntegerValueOnline()
effectively sets
parameter
on the
camera device.
Output Parameters
There are no output parameters associated with
Picam_SetParameterIntegerValueOnline()
Related APIs
For additional information, refer to the following related APIs:
• Picam_CommitParameters() .
camera: Handle for the camera being configured.
parameter:
Specifies the parameter that is to be configured.
Valid parameters are those of type
PicamValueType_Integer
.
value: The integer value with which the specified parameter is to be configured.