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

Page: 204 / 357

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