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

Page: 137 / 357

Chapter 5 Configuration APIs 137
5.4.1.18 Picam_GetParameterPulseDefaultValue()
Description
Picam_GetParameterPulseDefaultValue()
returns the default value for a specified
Pulse parameter.
Syntax
The syntax for
Picam_GetParameterPulseDefaultValue()
is:
PICAM_API Picam_GetParameterPulseDefaultValue(
PicamHandle camera,
PicamParameter parameter,
const PicamPulse** value);
Input Parameters
Input parameters for
Picam_GetParameterPulseDefaultValue()
are:
Output Parameters
Output parameters for
Picam_GetParameterPulseDefaultValue()
are:
Advanced API Usage
When used in conjunction with Advanced APIs,
camera
may be a handle to either the:
•
device
, or
•
model
.
Both the
device
and
model
share the same default value.
Related Structures
For additional information, refer to the following Pulse structure:
• PicamPulse .
Related APIs
For additional information, refer to the following related APIs:
•
Picam_DestroyPulses()
.
camera:
Handle for the camera for which the default parameter value is being
requested.
parameter:
Specifies the Pulse parameter for which the default value is to be
returned.
Valid parameters are those of type
PicamValueType_Pulse .
value:
Pointer to the memory location in which the default value for the
specified Pulse parameter has been stored.
NOTE: This memory is allocated by PICam and must be released
by calling
Picam_DestroyPulses() .