Purpose

This example demonstrates how to handle run-time errors using the SequenceFilePostStepRuntimeError Engine callback sequence.

Example File Location

<TestStand Public>\Examples\Fundamentals\Overriding Engine Callbacks\Overriding SequenceFilePostStepRuntimeError Callback.seq

Highlighted Features

Callbacks

Major API

Step.CancelStepCallback

Prerequisites

None

How to Use This Example

Complete the following steps to review the sequences and steps in this example.

1. On the Sequences pane, select the MainSequence. The MainSequence contains two Numeric Limit Test steps and one Sequence Call step.
2. On the Sequences pane, select the SubSequence sequence. The SubSequence sequence contains Numeric Limit Test steps, two of which are designed to cause run-time errors in the following ways to demonstrate how TestStand behaves when a run-time error occurs:
   • One test generates an error only the first time
   • One test generates an error every time
3. On the Sequences pane, select the SequenceFilePostStepRuntimeError callback. The first step, which uses the ActiveX/COM Adapter, sets the Step.CancelStepCallback property to True to suppress any other failure callbacks for a failed step.
4. On the Steps pane, select the Choose Action step.
5. On the Step Settings pane, click the Text and Buttons tab. The Message Expression control specifies an expression that provides information about the step that caused the run-time error, and the step specifies buttons so you can choose to retry the test, ignore the error, continue to the Cleanup step group, or terminate the execution. The Select step that follows the Choose Action step specifies the following cases that correspond to the buttons you can click in the message popup that the Choose Action step creates:
   • Case 1 ignores the error and changes the next step index to retry the step that caused the error
   • Case 2 ignores the error and specifies the step status as Error Suppressed.
   • Case 3 sets the RunState.Caller.Runstate.ErrorReported flag to True to prevent TestStand from displaying a run-time error dialog box because has already reported the error
   • Case 4 sets the RunState.Caller.Runstate.ErrorReported flag to True to prevent TestStand from displaying a run-time error dialog box because has already reported the error and then terminates the execution

Complete the following steps to run the example.

1. Select Execute»Single Pass to run the sequence.
2. TestStand launches the Error dialog box for the first step that causes a run-time error. Click the Retry button to run the step again. The step passes on the second attempt.
3. TestStand launches the Error dialog box for the next step that causes a run-time error. Click the Ignore Error button to continue executing the sequence.
4. When execution completes, review the report on the Report pane. The status of the first attempt of the Generate a run-time error only the first time step is Error, Retrying Step because you clicked the Retry button after the step caused a run-time error once. The status of the Generate a run-time error every time step is Error Suppressed because you clicked the Ignore Error button when the step caused a run-time error.