ISwitchV3GetSwitchValue Method

Returns the value for switch device id as a double

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
double GetSwitchValue(
	short id
)

Parameters

id  Int16
The device number (0 to MaxSwitch - 1)

Return Value

Double
The value for this switch, this is expected to be between MinSwitchValue(Int16) and MaxSwitchValue(Int16).

Remarks

See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition

Exceptions

InvalidOperationExceptionIf there is a temporary condition that prevents the device value being returned.
InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
NotConnectedExceptionIf the device is not connected
DriverExceptionAn 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.

Revision History

DateVersionDescription
ISwitchV2Platform 6.1Member added.

See Also