Syntax

String SwitchFindRoute(String device, String channel1, String channel2, Boolean raiseError = True, [Out] [Number capability])

Return Value

String

This function returns the route string that is available or already exists.

Purpose

This function finds an existing or potential route between two channels in the device defined in the National Instruments Switch Executive.

Parameters

device as String

The virtual device on which to performs the switching action.

channel1 as String

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 defined by the Switch Executive. Example: 'Dev1/CH2'

channel2 as String

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 defined by the Switch Executive. Example: 'Dev1/CH3'

raiseError as Boolean

An optional Boolean that specifies whether the function errors if the route is not available or does not already exist. The default value is True.

capability as Number

An optional output Number that indicate the capability of finding a valid route between the two channels.The valid return values are: 1 - Path available 2 - Path already exists, no route possible 3 - Path unsupported, no route possible 4 - Path possible but required resource in use, no route possible 5 - Both channels are sources, no route possible 6 - Channel cannot be an endpoint, no route possible