NI-RFPM API Reference

Table of Contents

RfpmSwitchPath.CanConnect Method

  • Updated2023-12-28
  • 1 minute(s) read
RfpmSwitchPath.CanConnect Method

RfpmSwitchPathCanConnect Method

Verifies whether the switch module can create a path between channel1 and channel2.

Namespace:  NationalInstruments.ModularInstruments.NIRfpmSwitch
Assembly:  NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40 (in NationalInstruments.ModularInstruments.NIRfpmSwitch.Fx40.dll) Version: 2023

Syntax

public PathCapability CanConnect(
	string channel1,
	string channel2
)
Public Function CanConnect ( 
	channel1 As String,
	channel2 As String
) As PathCapability

Parameters

channel1
Type: SystemString
The name of the first channel in the path.
channel2
Type: SystemString
The name of the last channel in the path.

Return Value

Type: PathCapability
A PathCapability indicating whether the switch module can create the path.

Exceptions

ExceptionCondition
SelectorNameExceptionchannel1 or channel2 was unknown or .
ObjectDisposedExceptionCanConnect(String, String) was called after the associated NIRfpmSwitch or RfpmSwitchDriverUtility object was disposed.
IviCDriverException The underlying NI-RFPM Switch driver returned an error.

Remarks

If the Switch module is capable of creating a path, this method indicates whether the path is currently available given the existing connections. If the path is not available due to currently existing connections, but the implicit connection between the two channels already exists, the method raises an ImplicitConnectionExistsWarningCode warning.

See Also

Log in to get a better experience