ISwitchV2GetSwitch Method

Return the state of switch device id as a boolean

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

bool GetSwitch(
	short id
)

VB

Function GetSwitch ( 
	id As Short
) As Boolean

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

InvalidOperationException	If there is a temporary condition that prevents the device value being returned.
InvalidValueException	If id is outside the range 0 to MaxSwitch - 1
NotConnectedException	When Connected is False.
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.

Version Information

.NET Standard

Supported in: 2.0