NI-SWITCH 19.0 .NET Framework 4.0 API Reference

Table of Contents

GetRelayName Method

  • Updated2023-02-21
  • 2 minute(s) read
GetRelayName Method
Returns the relay name string that is in the relay list at the specified index.

Namespace:  NationalInstruments.ModularInstruments.NISwitch
Assembly:  NationalInstruments.ModularInstruments.NISwitch.Fx40 (in NationalInstruments.ModularInstruments.NISwitch.Fx40.dll) Version: 19.0.0.49152 (19.0.0.49152)
Visual Basic (Declaration)
Public Function GetRelayName ( _
	index As Integer _
) As String
C#
public string GetRelayName(
	int index
)

Parameters

index
A 1-based index into the channel table. The default value is 1. The maximum value is the value of the NumberOfRelays property.

Return Value

Type: System..::.String
Returns a String that indicates the relay name string that is in the relay list at the specified index.

Exceptions

ExceptionCondition
ObjectDisposedException The GetRelayName method was accessed after the associated NISwitch.NISwitch object was disposed.

See Also

Log in to get a better experience