Example Code

ASK A QUESTION

by: Last Edited by:

Products and Environment

To download NI software, including the products shown below, visit ni.com/downloads.

Software

Teststand

Code and Documents

Attachment

Download All

Description

Overview

This example creates a new TestStand data type programmatically using the TestStand API. The example allows you to choose whether to store the type in the MyTypes.ini type palette, or in the current sequence file.

Description

This example shows how to access the TypeUsageList for a type palette file such as MyTypes.ini, or for the current Sequence file. The TypeUsageList is an object which contains all data and step types referenced by a particular file. The following methods are used by the example:

To access the TypeUsageList for a type palette

use Engine.GetTypePaletteFileList() method to retrieve the list of INI Files current loaded by TestStand. This method returns an array of PropertyObjectFile objects
Use the For Each step type to loop over each PropertyObjectFile in the list, and check the name using the PropertyObjectFile.DisplayName property.

To access the TypeUsageList for a Sequence File

Cast the SequenceFile reference to the more generic class propertyObjectFile using the SequenceFile.asPropertyObjectFile method

Once the example has stored the PropertyObjectFile reference to the destination for the type, it retrieves the TypeUsageList object from the property PropertyObjectFile.TypeUsageList. The TypeUsageList class provides methods and properties to operate type definitions.

The type object itself is created in the same way as any other PropertyObject, using the Engine.NewPropertyObject method and populates this container using the PropertyObject.SetValString and PropertyObject.SetValNumber methods with the PropOption_InsertIfMissnig flag to create the fields. The value you set for each field is the default value for the data type.

To insert the new PropertyObject into the Sequence File or Type Palette as a data type, use the TypeUsageList.InsertType method, then save the changes using the PropertyObjectFile.IncChangeCount and PropertyObjectFile.SaveIfModified.