GetTerminationState Method

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

Syntax

ApplicationMgr.GetTerminationState ( exec)

Return Value

ExecutionTerminationStates

Use the following constants with this data type:

  • ExecTermState_Aborting–(Value: 4) TestStand is aborting the running execution.
  • ExecTermState_KillingThreads–(Value: 5) TestStand is ending the threads in the execution.
  • ExecTermState_Normal–(Value: 1) The execution is not terminating.
  • ExecTermState_Terminating–(Value: 2) TestStand is terminating the running execution.
  • ExecTermState_TerminatingInteractive–(Value: 3) TestStand is terminating the running interactive execution.

Purpose

Returns the termination state of an execution.

Remarks

The value obtained from this method does not necessarily correspond to the value obtained from the Execution.GetStates method. The Execution.GetStates method returns the instantaneous state of the execution. This method returns the current state that the TestStand User Interface (UI) Controls display.

Note  When you write a user interface that uses TestStand UI Controls, National Instruments recommends using this method or the ExecutionViewMgr.TerminationState property instead of directly calling the Execution.GetStates method on the execution. A slight delay exists between when the instantaneous state of the execution changes and when TestStand updates the state this method returns to reflect the change. This occurs because the state this method returns does not change until TestStand processes the UIMessages involved, thus allowing for synchronization of the updates necessary for displaying an execution.

Parameters

exec As Execution

[In] Specifies the execution on which to operate.


See Also

ApplicationMgr.GetRunState

Execution.GetStates

ExecutionViewMgr.TerminationState

WAS THIS ARTICLE HELPFUL?

Not Helpful