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.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
public string GetSwitchDescription(
	short id
)
Visual Basic
Public Function GetSwitchDescription ( _
	id As Short _
) As String
Visual C++
public:
virtual String^ GetSwitchDescription(
	short id
) sealed

Parameters

id
Type: System..::..Int16
The number of the device whose description is to be returned

Return Value

String giving the device description.

Implements

ISwitchV2..::..GetSwitchDescription(Int16)

Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

This method was first introduced in Version 2.

Exceptions

ExceptionCondition
ASCOM..::..MethodNotImplementedExceptionIf the method is not implemented
ASCOM..::..InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1

See Also