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

Page: 205 / 357

Chapter 7 Advanced Function APIs 205
7.2.2.4 PicamDependentValidationResult
Description
PicamDependentValidationResult
provides information about the failed validation
of a parameter that is constrained by a second parameter.
Structure Definition
The structure definition for
PicamDependentValidationResult
is:
typedef struct PicamDependentValidationResult
{
pibln is_valid;
PicamParameter constraining_parameter;
const PicamFailedDependentParameter*
failed_dependent_parameter_array;
piint
failed_dependent_parameter_count;
} PicamDependentValidationResult;
Variable Definitions
The variables required by
PicamDependentValidationResult
are:
is_valid: Indicates the validation status for a parameter that is
constrained by a second parameter.
Valid values are:
• TRUE
Indicates the parameter validation has succeeded.
• FALSE
Indicates the parameter validation has failed.
constraining_parameter: The parameter whose value impacts the constraints of
another.
failed_dependent_
parameter_array:
An array containing all parameters whose constraints are
dependent on
constraining_parameter
and that have
failed validation.
This is null when the validation has succeeded.
failed_dependent_
parameter_count:
The number of items in an array containing all parameters
whose constraints are dependent on
constraining_parameter
and that have failed validation.
This is 0 when the validation has succeeded.