Abort Scan

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.

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.

Inputs/Outputs

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

Default value: 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

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.