niSwitch Abort Scan VI

NI Switches Help

Edition Date: April 2015

Part Number: 375472H-01

»View Product Info
Download Help (Windows Only)

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

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

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

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 VI). 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.

Related Topics

niSwitch Abort Scan

/images/reference/en-XX/help/375472H-01/cio.gif

instrument handle identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology VI, the niSwitch Initialize With Options VI, or the niSwitch Initialize VI.

/images/reference/en-XX/help/375472H-01/cerrcodeclst.gif

error in describes error conditions that occur before this node runs. With the following exception, this input provides standard error in functionality. This node runs normally even if an error occurred previously. If an error occurred before this node runs, the node passes the error in value to error out, and no errors that occur while this node runs are recorded. If an error occurs while this node runs and no error occurred previously, the node sets its own error status in error out. The default is no error.

/images/reference/en-XX/help/375472H-01/cbool.gif

status is TRUE (X) if an error occurred before this VI ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI ran. The default is FALSE.

/images/reference/en-XX/help/375472H-01/ci32.gif

code is the error or warning code. The default is 0. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.

/images/reference/en-XX/help/375472H-01/cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning. The default is an empty string.

/images/reference/en-XX/help/375472H-01/iio.gif

instrument handle out identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology VI, the niSwitch Initialize With Options VI, or the niSwitch Initialize VI and used for all subsequent NI-SWITCH calls.

/images/reference/en-XX/help/375472H-01/ierrcodeclst.gif

error out contains error information. This output provides standard error out functionality.

/images/reference/en-XX/help/375472H-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/375472H-01/ii32.gif

code is the error or warning code. If status is TRUE, code is a non-zero error code. If status is FALSE, code is 0 or a warning code.

/images/reference/en-XX/help/375472H-01/istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI that produced the error or warning.

WAS THIS ARTICLE HELPFUL?

Not Helpful