NewDataType Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewDataType ( ValueType, asArray, typeNameParam, options)

Return Value

PropertyObject

The newly created data type.

Purpose

Creates and returns a new TestStand data type.

Remarks

This method creates a PropertyObject object that is a data type. Once you create a data type, you can use the Engine.NewPropertyObject method to create an instance of the type. You can add the type to a TypeUsageList to associate the type with a particular PropertyObjectFile.

Note  TestStand does not validate data type names you create programmatically for invalid characters, such as spaces, which can result in errors when you use the data type. Use the TypeUsageList.ValidateNewTypeName method to validate type names. TestStand requires data type names to be strings that contain only letters, numbers, and underscores. Type names cannot duplicate type names already in memory.

Parameters

ValueType As PropertyValueTypes

[In] Specifies the type of value you want instances of the type to contain.

asArray As Boolean

[In] Pass True if you want the type to be an array.

typeNameParam As String

[In] If you pass PropValType_NamedType for the ValueType, pass the name of the type for this parameter. Otherwise, pass an empty string. If you pass a type name, the type must not already be in memory.

options As Long

[In] Pass 0 to specify the default behavior, or pass one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.


See Also

Engine.NewPropertyObject

NamedPropertyTypes

PropertyObject

PropertyObjectFile

PropertyOptions

PropertyValueTypes

TypeUsageList

TypeUsageList.ValidateNewTypeName

WAS THIS ARTICLE HELPFUL?

Not Helpful