ISwitchV2.GetSwitchDescription Method
Click or drag to resize

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.4.0.2618)
Syntax
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
ExceptionCondition
InvalidValueExceptionIf 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.

See Also