NewHierarchicalExecution Method

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Engine.NewHierarchicalExecution ( sequenceCallSteps, hierarchicalExecutionFlags, sequenceFileParam, sequenceNameParam, processModelParam, breakAtFirstStep, executionTypeMaskParam, [sequenceArgsParam], [editArgsParam], [InteractiveArgsParam])

Return Value

Execution

Purpose

Creates and returns a new Execution object.

Remarks

Use a hierarchical execution to specify a call stack of Sequence Call steps that only execute the setup and Cleanup steps of sequences in the call stack while continuing normal execution in the sequence that the last Sequence Call step specifies.

To specify the call stack to create, pass an array of Sequence Call steps to the sequenceCallSteps parameter. When the hierarchical execution starts, TestStand executes the sequence the sequenceName parameter specifies, just as TestStand does when you call the Engine.NewExecution method. When the execution reaches the sequence that contains the first Sequence Call step the sequenceCallSteps parameter specifies, the execution follows the execution path the array of Sequence Call steps defines. The execution does not execute any of the Main steps in the sequences of the call stack, but the hierarchicalExecutionFlags parameter specifies whether the execution executes the setup and Cleanup steps in the sequences of the call stack. Execution resumes normally in the sequence that the last Sequence Call step in the array calls. Even though the steps in the Main step group of the sequences that contain the Sequence Call steps do not execute, local variables propagate normally according to their propagation settings.

Parameters

sequenceCallSteps As Object Array

[In] Specifies an array of Sequence Call steps. The array represents a call stack to recreate. The execution does not execute any of the main steps in the sequences of the call stack, but the hierarchicalExecutionFlags parameter specifies whether the execution executes the setup and cleanup steps in the sequences of the call stack. Except for the first step, each step in the array is a step that resides in the sequence the previous step in the array calls.

hierarchicalExecutionFlags As Long

[In] Pass 0 for the default behavior or pass one or more HierarchicalExecutionFlags constants. Use the bitwise-OR operator to pass multiple constants.

sequenceFileParam As SequenceFile

[In] Specifies the SequenceFile object that contains the sequence to execute. If the execution uses a process model, pass the client SequenceFile object.

sequenceNameParam As String

[In] Specifies the name of the sequence or Process Model entry point to execute.

processModelParam As SequenceFile

[In] Pass the process model SequenceFile object if you want to execute a Process Model entry point. Otherwise, a NULL object reference in LabVIEW, 0 in LabWindows/CVI, or the Nothing keyword in Visual Basic, pass a NULL dispatch pointer in Microsoft Foundation Classes.

breakAtFirstStep As Boolean

[In] Pass True to suspend execution before executing the first step.

executionTypeMaskParam As Long

[In] Pass 0 for the default behavior or pass one or more ExecutionTypeMask constants. Use the bitwise-OR operator to pass multiple constants.

sequenceArgsParam As Variant

[In] [Optional] Specifies a PropertyObject object that contains the arguments to the sequence you want to execute. Each subproperty of the PropertyObject object represents a parameter to the sequence. The subproperties must appear in the same order as the sequence parameters.

editArgsParam As Variant

[In] [Optional] Specifies an EditArgs object that indicates which items are currently selected in the user interface. This is required only for Process Model entry points.

InteractiveArgsParam As Variant

[In] [Optional] Specifies an InteractiveArgs object that indicates which steps are currently selected in the user interface and contains looping information necessary for an interactive execution. Pass this parameter for interactive executions only.


See Also

EditArgs

Engine.NewEditArgs

Engine.NewExecution

Engine.NewInteractiveArgs

Execution

ExecutionTypeMask

HierarchicalExecutionFlags

InteractiveArgs

Omitting Optional Parameters

SequenceFile

WAS THIS ARTICLE HELPFUL?

Not Helpful