Purpose

This example shows how to access built-in and dynamic TestStand properties. Built-in TestStand properties are defined by the TestStand API, and are available for any object of a given class. Dynamic properties, also known as SubProperties, can vary between objects of the same class.

Example File Location

<TestStand Public>\Examples\TestStand API\Accessing Properties Using API\TestStand Expressions\Accessing Properties Using API.seq

Highlighted Features

  • Built-In Properties
  • Dynamic Properties
  • RunState Property
  • TestStand API

Major API

  • PropertyObject.GetValNumber
  • PropertyObject.GetValString
  • PropertyObject.SetValNumber
  • PropertyObject.SetValBoolean
  • PropertyObject.SetValVariant

Prerequisites

None

How to Use This Example

Complete the following steps to run the example:

  1. Select Execute»Run MainSequence to execute the sequence.
  2. As the example executes, read the message popups for information about built-in and dynamic properties and how they are accessed.

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

  1. Open the Accessing Built-In Properties sequence from the Sequences pane. Review the statement steps in this sequence. These steps access built-in properties and methods using the TestStand API.
  2. Open the Accessing Dynamic Properties sequence from the Sequences pane. Review the first set of statement steps under the Get Step Properties label. These steps use the TestStand PropertyObject methods to get the values of dynamic step properties.
  3. Review the set of statement steps under the Set Step Properties label. These steps use the TestStand PropertyObject methods to set the values of dynamic step properties.
  4. Review the set of statement steps under the Get Step Properties label. These steps use the TestStand ProprtyObject methods to set the value of a local variable, and dynamically create a local variable that exists only at run-time.