niSwitch Get Path VI

NI Switches Help

Edition Date: April 2015

Part Number: 375472H-01

»View Product Info
Download Help (Windows Only)

Returns a string that identifies the explicit path created with the niSwitch Connect Channels VI. Pass this string to the niSwitch Set Path VI 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 VI, NI-SWITCH selects an available path; however, the driver may not always select the same path through the switch module.

This VI only returns those paths explicitly created by the niSwitch Connect Channels VI or the niSwitch Set Path VI. 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.

Related Topic

niSwitch Get Path

/images/reference/en-XX/help/375472H-01/cio.gif

instrument handle identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology VI, the niSwitch Initialize With Options VI, or the niSwitch Initialize VI.

/images/reference/en-XX/help/375472H-01/cstr.gif

channel 1 specifies one of the channel names of the desired path. Pass the other channel name as channel 2. Refer to Devices for valid channel names for the switch module.

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

/images/reference/en-XX/help/375472H-01/cstr.gif

channel 2 specifies one of the channel names of the desired path. Pass the other channel name as channel 1. Refer to Devices for valid channel names for the switch module.

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

/images/reference/en-XX/help/375472H-01/cerrcodeclst.gif

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

/images/reference/en-XX/help/375472H-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/375472H-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/375472H-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/375472H-01/iio.gif

instrument handle out identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology VI, the niSwitch Initialize With Options VI, or the niSwitch Initialize VI and used for all subsequent NI-SWITCH calls.

/images/reference/en-XX/help/375472H-01/istr.gif

path is a string 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.

/images/reference/en-XX/help/375472H-01/ierrcodeclst.gif

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

/images/reference/en-XX/help/375472H-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/375472H-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/375472H-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.

WAS THIS ARTICLE HELPFUL?

Not Helpful