SwitchGetSwitchDescription 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.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484

Syntax

public string GetSwitchDescription(
	short id
)

Public Function GetSwitchDescription ( 
	id As Short
) As String

public:
virtual String^ GetSwitchDescription(
	short id
) sealed

id: Type: SystemInt16
The number of the device whose description is to be returned

Type: String
String giving the device description.

Exceptions

Exception	Condition
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. The device did not successfully complete the request.

Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

This method was first introduced in Version 2.

SwitchAddLanguageSpecificTextSet("LST2979A345_0?cpp=::|nu=.");GetSwitchDescription Method