ApplicationMgr.GetRunState

Syntax

ApplicationMgr.GetRunState( exec)

Return Value

ExecutionRunStates

Use the following constants with this data type:

  • ExecRunState_Paused –(Value: 2) The execution is suspended.
  • ExecRunState_Running –(Value: 1) The execution is running.
  • ExecRunState_Stopped –(Value: 3) The execution has finished executing.

Purpose

Returns the run 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 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.RunState 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.GetTerminationState

Execution.GetStates

ExecutionViewMgr.RunState