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: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484

Syntax

C++

Copy

string GetSwitchDescription(
	short id
)

Function GetSwitchDescription ( 
	id As Short
) As String

String^ GetSwitchDescription(
	short id
)

Parameters

id: Type: SystemInt16
The device number (0 to MaxSwitch - 1)

Return Value

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. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

Decices are numbered from 0 to MaxSwitch - 1

This is a Version 2 method.

Reference

ISwitchV2 Interface

ASCOM.DeviceInterface Namespace

ISwitchV2AddLanguageSpecificTextSet("LSTAC0BFA72_0?cpp=::|nu=.");GetSwitchDescription Method

Parameters

Return Value

Reference

ISwitchV2GetSwitchDescription Method