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

Page: 203 / 357

Chapter 7 Advanced Function APIs 203
7.2.2 Camera-Specific Parameter Validation Data Structures
This section provides programming information about camera-specific parameter
validation structures.
7.2.2.1
PicamValidationResult
Description
PicamValidationResult
provides information about the validation status for a single
parameter.
Structure Definition
The structure definition for
PicamValidationResult
is:
typedef struct PicamValidationResult
{
pibln is_valid;
const PicamParameter* failed_parameter;
const PicamConstraintScope* failed_error_constraint_scope;
const PicamConstraintScope* failed_warning_constraint_scope;
const PicamParameter* error_constraining_parameter_array;
piint error_constraining_parameter_count;
const PicamParameter* warning_constraining_parameter_array;
piint warning_constraining_parameter_count;
} PicamValidationResult;
Variable Definitions
The variables required by
PicamValidationResult
are:
is_valid:
Indicates the validation status for a single parameter.
Valid values are:
• TRUE
Indicates the parameter validation has succeeded.
• FALSE
Indicates the parameter validation has failed.
failed_parameter: The parameter that has failed validation.
This is null when validation has succeeded.
failed_error_constraint
_scope:
The scope of the error constraint that has failed.
This is null when:
• Validation has succeeded, or
• Only a warning constraint has failed validation.
failed_warning_
constraint_scope:
The scope of the warning constraint that has failed.
This is null when:
• Validation has succeeded, or
• Only an error constraint has failed validation.
error_constraining_
parameter_array:
An array of parameters involved in constraining the failed
parameter when a dependent error failed.
This is null otherwise.
error_constraining_
parameter_count:
The number of items in the array of parameters involved in
constraining the failed parameter if a dependent error failed.
This is 0 otherwise.
warning_constraining_
parameter_array:
An array of parameters involved in constraining the failed
parameter if a dependent warning failed.
This is null otherwise.
warning_constraining_
parameter_count:
The number of items in the array of parameters involved in
constraining the failed parameter if a dependent warning
failed.
This is 0 otherwise.