ISwitchV2.GetSwitchDescription Method

ISwitchV2GetSwitchDescription 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.

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.2.0.2774)

Syntax

string GetSwitchDescription(
	short id
)

Function GetSwitchDescription ( 
	id As Short
) As String

String^ GetSwitchDescription(
	short id
)

Type: String
String giving the device description.

Exceptions

Exception	Condition
InvalidValueException	If id is outside the range 0 to MaxSwitch - 1

Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

Decices are numbered from 0 to MaxSwitch - 1

This is a Version 2 method.