|Download Help (Windows Only)|
Owning Palette: Application Control VIs and Functions
Requires: Base Package
Stops the VI in which it executes, just as if you clicked the Abort Execution button on the toolbar. Before you call this function with a TRUE input, be sure to complete all final tasks for the VI first, such as closing files, setting safe values for devices being controlled, and so on.
If you wired the input, stop occurs only if the input value is TRUE. The default is to stop as soon as the node that is currently executing finishes.
|stop? is the Boolean value that determines if the VI stops. If you wire an error cluster to stop? and an error occurs, the error cluster passes a TRUE value to the function.|
If you need to abort execution of all VIs in a hierarchy from the block diagram, you can use this function, but you must use it with caution. If you put this function in a subVI, you should make its behavior clear to other users of the VI because this function causes their VI hierarchies to abort execution.
In general, avoid using this function when you have a built-in termination protocol in a VI. For example, I/O operations should be performed in While Loops so that the VI can terminate the loop on an I/O error. Also, consider using a front panel stop button Boolean control to terminate the loop at the request of the user rather than using this function.