niSE Find Route VI

NI Switch Executive 2015 Help

Edition Date: August 2015

Part Number: 370404J-01

»View Product Info

Finds an existing or potential route between channel 1 and channel 2.

Details

niSE Find Route

/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

Channel 1 ("") is the channel name of one of the endpoints of the route to find. The channel name must either be a channel alias name or a name in the device/ivichannel syntax.

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

Channel 2 ("") is the channel name of one of the endpoints of the route to find. The channel name must either be a channel alias name or a name in the device/ivichannel syntax.

/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/istr.gif

Route Specification contains the fully specified route path surround by square brackets—if the route exists or is possible. Refer to Route Specification Strings for more information.

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

Path Capability is the return value which expresses the capability of finding a valid route between channel 1 and channel 2.

Path Available (1)

A path between channel 1 and channel 2 is available. The Route Specification parameter returns a string describing the available path.

Path Exists (2)

A path between channel 1 and channel 2 already exists. The Route Specification parameter returns a string describing the existing path.

Path Unsupported (3)

There is no potential path between channel 1 and channel 2 given the current configuration.

Resource In Use (4)

There is a potential path between channel 1 and channel 2, although a resource needed to complete the path is already in use.

Exclusion Conflict (5)

Channel 1 and channel 2 cannot be connected because their connection would result in an exclusion violation.

Channel Not Available (6)

One of the channels is not useable as an endpoint channel. Make sure that it is not marked as a configuration channel.

Channels Hardwired (7)

The two channels reside on the same hardwire. An implicit path already exists.

/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

The returned route specification contains the route specification, and the route capability indicates whether the route existed, is possible, or is not possible for various reasons.

The Route Specification string returned from the niSE Find Route VI can be passed to other NI Switch Executive API VIs, such as the niSE Connect VI, niSE Disconnect VI, and niSE Connect And Disconnect VI, that use Route Specification Strings.

WAS THIS ARTICLE HELPFUL?

Not Helpful