NewStep Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewStep ( adapterKeyNameVal, stepTypeName)

Return Value

Step

Purpose

Creates and returns a new Step object.

Remarks

Pass the new Step object to the Sequence.InsertStep method to add a step to a sequence.

When you use this method to create a new Step object, the step name is empty. You can use the following code snippet to set the default name of the new step:


Step.Name = Step.StepType.AsPropertyObject.EvaluateEx(Step.StepType.DefaultNameExpr, EvalOption_DoNotAlterValues).GetValString("", 0)

Note  TestStand does not validate step names you create programmatically for invalid characters. Use the PropertyObject.ValidateNewElementName method to validate step names. Step names in a sequence can contain any character.

Parameters

adapterKeyNameVal As String

[In] Specifies the key name of the module Adapter object to use to create the step. Pass an empty string to use the adapter the step type designates or, if the step has no designated adapter, to use the adapter the Engine.DefaultAdapter property specifies.

stepTypeName As String

[In] Specifies the name of the step type with which to create the step. The step type must already be in memory. The sequence editor and custom user interfaces load step types into memory when calling the Engine.LoadTypePaletteFilesEx method or when loading a sequence file from disk. To create a new step type, use the Engine.NewStepType method.


See Also

AdapterKeyNames

Engine.DefaultAdapter

Engine.LoadTypePaletteFilesEx

Engine.NewStepType

PropertyObject.ValidateNewElementName

Sequence.InsertStep

Sequence.RemoveStep

Step

Step.CreateNewUniqueStepId

StepTypes

WAS THIS ARTICLE HELPFUL?

Not Helpful