Home Support NI Product Manuals NI-SWITCH 17.5 to 20.1 Manual

Table Of Contents

Abort Scan (G Dataflow)

Download Manual | Offline Viewer Required
Version:
Last Modified: September 16, 2017

Aborts the scan in progress. Use the niSwitch Initiate Scan node to initiate an aborted scan.

If the switch module is not scanning, a No Scan In Progress error is returned.

spd-note-note
Note

If you are using a legacy resource descriptor (SCXI:: or PXI::) and you abort a scan, the switch module returns to a disconnect all state (equivalent to calling the niSwitch Disconnect All Channels node). If you are using an NI-DAQmx resource descriptor (DAQmx device name), the switch module returns to the state it was in before the scan was initiated.

connector_pane_image
datatype_icon

session in

Control that identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology node, the niSwitch Initialize With Options node, or the niSwitch Initialize node.

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

session out

Indicator that identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology node, the niSwitch Initialize With Options node, or the niSwitch Initialize node and used for all subsequent NI-SWITCH calls.

datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Understanding Errors

If error in describes an error that had occurred before calling this node, the node still attempts to abort the scan. However, if the attempt fails, the node returns the error information that was passed in from the error in parameter.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application

Recently Viewed Topics