Get Path
- Updated2023-05-15
- 3 minute(s) read
Get Path
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.
Inputs/Outputs
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.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
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.
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.
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.
error out
Error information.
The node produces this output according to standard error behavior.
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.