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\LabVIEW\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. Select the Access Built-in properties step, then click Edit VI in the Module tab of the Step Settings pane to open the code module. This code module uses the TestStand API to access built-in properties and methods.
  2. Open the Accessing Dynamic Properties sequence from the Sequences pane. Select the Get Step Results step, then click Edit VI in the Module tab of the Step Settings pane to open the code module. This code module uses the TestStand PropertyObject methods to get the values of dynamic step properties.
  3. Select the Set Step Results step, then click Edit VI in the Module tab of the Step Settings pane to open the code module. This code module uses the TestStand PropertyObject methods to set the values of dynamic step properties.
  4. Select the Set Variables step, then click Edit VI in the Module tab of the Step Settings pane to open the code module. This code module uses the TestStand PropertyObject methods to set the value of a local variable, and create a new local variable that exists only at run-time.