ISwitchV3GetSwitch Method

Return the state of switch device id as a boolean

Definition

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

Parameters

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

Return Value

Boolean
True or false

Remarks

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

Exceptions

InvalidValueExceptionIf id is outside the range 0 to MaxSwitch - 1
InvalidOperationExceptionIf there is a temporary condition that prevents the device value being returned.
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
ISwitchPlatform 5.0Member added.

See Also