ISwitchV2GetSwitchName Method

Return the name of switch device n.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

string GetSwitchName(
	short id
)

VB

Function GetSwitchName ( 
	id As Short
) As String

Parameters

id Int16: The device number (0 to MaxSwitch - 1)

Return Value

String
The name of the device

Remarks

See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition

Exceptions

NotConnectedException	When Connected is False.
DriverException	An error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.
InvalidValueException	If id is outside the range 0 to MaxSwitch - 1

Version Information

.NET Standard

Supported in: 2.0