Home Support NI Product Manuals NI-SWITCH 17.5 to 20.1 Manual

Table Of Contents

Get Path (G Dataflow)

Download Manual | Offline Viewer Required
Version:
Last Modified: January 17, 2018

Returns a string that identifies the explicit path created with the niSwitch Connect Channels node. Pass this string to the niSwitch Set Path node to establish the exact same path in future connections.

In some cases, multiple paths are available between two channels. When you call the niSwitch Connect Channels node, NI-SWITCH selects an available path; however, the driver may not always select the same path through the switch module.

This node returns only those paths explicitly created by the niSwitch Connect Channels node or the niSwitch Set Path node. For example, if you connect channels CH1 and CH3,and then channels CH2 and CH3, an explicit path between channels CH1 and CH2 does not exist, and an error is returned.

connector_pane_image
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

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

channel 1

One of the channel names of the desired path. Pass the other channel name as channel 2.

Examples of valid channel names are ch0, com0, ab0, r1, c2, and cjtemp.

datatype_icon

channel 2

One of the channel names of the desired path. Pass the other channel name as channel 1.

Examples of valid channel names are ch0, com0, ab0, r1, c2, and cjtemp.

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

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
datatype_icon

path

String that is composed of comma-separated paths between channel 1 and channel 2.

The first and last names in the path are the path endpoints. All other channels in the path are configuration channels.

Examples of returned paths:

ch0>com0, com0>ab0.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application

Recently Viewed Topics