Teledyne Princeton Instruments PICam 5.x Programmer's Manual page 204

204
7.2.2.2 PicamValidationResults
Description
PicamValidationResults
multiple parameters.
Structure Definition
The structure definition for
Variable Definitions
The variables required by
validation_result_array: An array containing a result for each parameter that failed
validation_result_count: The number of failed parameter results; 0 if validation
PicamFailedDependentParameter
7.2.2.3
Description
PicamFailedDependentParameter
failed validation and is itself constrained by a second parameter.
Structure Definition
The structure definition for
Variable Definitions
The variables required by
failed_error_constraint
PICam™ 5.x Programmer's Manual
provides information about the validation status for
PicamValidationResults
typedef struct PicamValidationResults
{
const PicamValidationResult* validation_result_array;
} PicamValidationResults;
PicamValidationResults
is_valid: Indicates the validation status for multiple tested parameters.
Valid values are:
validation; null if validation succeeded.
succeeded.
PicamFailedDependentParameter
typedef struct PicamFailedDependentParameter
{
PicamParameter failed_parameter;
const PicamConstraintScope* failed_error_constraint_scope;
const PicamConstraintScope* failed_warning_constraint_scope;
} PicamFailedDependentParameter;
PicamFailedDependentParameter
failed_parameter: The parameter whose validation failed and is constrained by
another.
The scope of the error constraint that failed.
_scope:
This is null when only a warning constraint failed.
The scope of the warning constraint that failed.
failed_warning_
constraint_scope:
This is null when only an error constraint failed.
is:
pibln is_valid;
piint validation_result_count;
are:
• TRUE
Indicates all parameter validations have succeeded.
• FALSE
Indicates one or more parameter validations has failed.
provides information about a parameter that has
Issue 11
is:
are: