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.1.1.2619)

Syntax

C#
string GetSwitchDescription(
	short id
)
Visual Basic
Function GetSwitchDescription ( _
	id As Short _
) As String
Visual C++
String^ GetSwitchDescription(
	short id
)

Parameters

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

Return Value

String giving the device description.

Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

Decices are numbered from 0 to MaxSwitch - 1

This is a Version 2 method.

Exceptions

ExceptionCondition
ASCOM..::..InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1

See Also