ISwitchV3GetSwitchDescription Method

Gets the description of the specified switch device. This is to allow a fuller description of the device to be returned, for example for a tool tip.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b

C#

string GetSwitchDescription(
	short id
)

VB

Function GetSwitchDescription ( 
	id As Short
) As String

C++

String^ GetSwitchDescription(
	short id
)

String
String giving the device description.

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

InvalidValueException	If id is outside the range 0 to MaxSwitch - 1
NotConnectedException	If the device is not connected
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.

Date	Version	Description
ISwitchV2	Platform 6.1	Member added.