niSE Connect VI

NI Switch Executive 2015 Help

Edition Date: August 2015

Part Number: 370404J-01

»View Product Info

Connects the routes specified by the connection specification. When connecting, it may allow for multiconnection based on the multiconnection mode.

Details

niSE Connect

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

Multiconnect Mode (Use Default Mode) sets the connection mode for the VI.

The mode may be one of the following:

Default (-1)

Uses the mode selected as the default for the route in the NI Switch Executive virtual device configuration. If a mode has not been selected for the route in the NI Switch Executive virtual device, this parameter defaults to Multiconnect Routes.

No Multiconnect (0)

Routes specified in the connection specification must be disconnected before they can be reconnected. Calling the niSE Connect VI on a route that was connected using No Multiconnect mode results in an error condition.

Multiconnect Routes (1)

Routes specified in the connection specification can be connected multiple times. The first call to the niSE Connect VI performs the physical hardware connection. Successive calls to the niSE Connect VI increase a connection reference count. Similarly, calls to the niSE Disconnect VI decrease the reference count. When it reaches 0, the hardware is physically disconnected. This behavior is slightly different with SPDT relays. For more information, refer to Exclusions and SPDT Relays. Multiconnecting routes applies to entire routes and not to route segments.

/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

Connection Specification ("") is the string describing the connections 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/cbool.gif

Wait For Debounce (T), if TRUE, waits for all switches to debounce before it returns. If FALSE, it immediately returns after the switch control is completed.

Note  In either case, the wait for debounce occurs after the connection portion of operation. If you need finer grained control of this debounce behavior, consider calling the niSE Connect VI and the niSE Disconnect VI separately.
/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

In the event of an error, the call to the niSE Connect VI attempts to undo any connections made so that the system is left in the same state that it was in before the call was made. Some errors can be caught before manipulating hardware, although it is feasible that a hardware call could fail causing some connections to be momentarily closed and then reopened.

WAS THIS ARTICLE HELPFUL?

Not Helpful