Custom Result Properties

TestStand 2016 Help

Edition Date: August 2016

Part Number: 370052R-01

»View Product Info
Download Help (Windows Only)

Each step type defines a set of custom result properties. All steps that use the step type have the same set of custom properties.

All built-in step types contain the following custom properties:

  • Step.Result.Error.Code—Code that describes the error that occurred.
    Note Note  TestStand supports only 32-bit signed integer values for the run-time error code property. Although you can assign a larger or fractional value to the property, TestStand will truncate the value to 32-bit when handling and propagating a run-time error.
  • Step.Result.Error.Msg—Message string that describes the error that occurred.
  • Step.Result.Error.Occurred—Boolean flag that indicates a run-time error occurred in the step. TestStand documentation refers to this property as the error occurred flag.

    The error occurred flag can become True when a run-time error condition occurs and the code module or module adapter sets the value to True or when an unhandled exception occurs in the code module or at any other time during step execution. When a step finishes execution and the error occurred flag is True, the TestStand Engine responds in the following ways:
    • Does not evaluate the status and post-expressions for a step and sets the step status to Error.
    • Evaluates the Ignore Run-Time Errors step property.
      • When this property is False, TestStand reports the run-time error to the sequence.
      • When this property is True, TestStand continues execution normally after the step.
  • Step.Result.Status—The status of the last execution of the step, such as Done, Passed, Failed, Skipped, or Error. TestStand documentation refers to this property as the step status.

    Before TestStand executes a step, it sets the step status to Running or Looping. When a step finishes execution and the error occurred flag is False, TestStand changes the step status to Done. The step status becomes Passed or Failed only when a code module, module adapter, or step type explicitly sets the step status to Passed or Failed.
  • Step.Result.ReportText—Message string TestStand includes in the report.
  • Step.Result.Common—Placeholder container you can customize by modifying the CommonResults standard data type.
Note Note   The preceding list does not include the result properties that are unique for each built-in step type or for Synchronization, Database, Interchangeable Virtual Instrument (IVI), or LabVIEW Utility step types.

The Common property uses the CommonResults custom data type and is a subproperty of the Result property for every step type. Consequently, you can add a subproperty to the result of every step type by adding a subproperty to the definition of the CommonResults custom data type. When you modify the CommonResults data type, you must ensure that the new type definition does not conflict with earlier versions of the type in other files. National Instruments recommends modifying the CommonResults data type only when you want to perform an architectural change to all step types that you use.

Note Note  Share the modified CommonResults data type and the step types that use the CommonResults data type only with systems on which you are certain you will not deploy any conflicting changes to CommonResults.

See Also

Result Collection

Exceptions

Standard Result Properties

WAS THIS ARTICLE HELPFUL?

Not Helpful