Click or drag to resize
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: 6.0.0.0 (6.3.0.2839)
Syntax
public string GetSwitchDescription(
	short id
)

Parameters

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

Return Value

Type: String
String giving the device description.

Implements

ISwitchV2GetSwitchDescription(Int16)
Exceptions
ExceptionCondition
MethodNotImplementedExceptionIf the method is not implemented
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
Remarks

Must be implemented, must not throw an ASCOM.MethodNotImplementedException

This method was first introduced in Version 2.

See Also