ASCOM Library
ISwitch
Sets a switch controller device to the specified state, true or false.
Definition
Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
void SetSwitch(
short id,
bool state
)VB
Sub SetSwitch (
id As Short,
state As Boolean
)Parameters
Remarks
Can throw a NotImplementedException if CanWrite(Int16) is False.
GetSwitchValue(Int16) must return MaxSwitchValue(Int16) if the set state is true and MinSwitchValue(Int16) if the set state is false.
Devices are numbered from 0 to MaxSwitch - 1
Exceptions
| NotImplementedException | If CanWrite(Int16) is false. |
| 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. |