Utility Functions and C Language Reference > Utility Functions: C Language (lr_) > Alphabetical Listing > lr_checkpoint

lr_checkpoint

Validates the value of a parameter against an expected value (checkpoint).

C Language

int lr_checkpoint( "StepName=<step_name>", "ActualValue={<input_param>}", "Compare=<operator>", "ExpectedValue={<checkpoint>}", "StopOnValidationError=<error_code>", LAST );
Example: lr_checkpoint Parameter Functions

Arguments

Name Comments
StepName The name of the step, as it appears in the test tree. Any text can be used.
ActualValue Data to compare with the ExpectedValue argument. Can be a value or a parameter.
Compare Operator used to compare the ActualValue and ExpectedValue values:
  • Equals

  • NotEquals

  • Contains

  • StartsWith

  • EndsWith

ExpectedValue Data to compare with the ActualValue argument. Can be a value or a parameter.
StopOnValidationError Indication of whether all steps fail. Valid values: false: Steps do not fail. true: Steps fail.
LAST This delimiter marks the end of the argument list.

The lr_checkpoint function validates the value of a parameter against a checkpoint value.

This function is supported only under the Windows operating system.

If the validation fails, the script aborts or continues, depending on the values of the StopOnValidationError argument and the Continue on Error runtime setting. The Continue on Error runtime setting takes precedence over the value of StopOnValidationError.

Operators are case-sensitive.

This function is not recorded. It can be added manually when enhancing the script.

Return Values

This function returns LR_PASS on success and LR_FAIL on failure.

Parameterization

All string arguments (char type) can be parameterized using standard parameterization.