niSE Disconnect VI

NI Switch Executive 2015 Help

Edition Date: August 2015

Part Number: 370404J-01

»View Product Info

Disconnects the routes specified in the Disconnection Specification parameter.

This function will not wait for debounce. Call the niSE Wait for Debounce function to wait for debounce.

Details

niSE Disconnect

/images/reference/en-XX/help/370404J-01/crn.gif

NISE Session (in) is the session referencing this NI Switch Executive virtual device. Session handles are created through a call to the niSE Open Session VI.

/images/reference/en-XX/help/370404J-01/cstr.gif

Disconnection Specification ("") is the string describing the disconnections to be made. Refer to Route Specification Strings for more information.

/images/reference/en-XX/help/370404J-01/cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

/images/reference/en-XX/help/370404J-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/370404J-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/370404J-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/370404J-01/irn.gif

NISE Session (out) is the session referencing this NI Switch Executive virtual device. Session handles are created through a call to the niSE Open Session VI. This session handle is the copy of the session handle that was passed in and provides for easier wiring between NI Switch Executive VIs.

/images/reference/en-XX/help/370404J-01/ierrcodeclst.gif

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

/images/reference/en-XX/help/370404J-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/370404J-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/370404J-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.

Details

If any of the specified routes were originally connected in a multiconnected mode, the call to the niSE Disconnect VI reduces the reference count on the route by 1. If the reference count reaches 0, it is disconnected.

If a specified route does not exist, it is an error condition.

In the event of an error, the call to the niSE Disconnect VI continues to try to disconnect everything specified by the route specification string but reports the error on completion.

WAS THIS ARTICLE HELPFUL?

Not Helpful