ISwitchV2SetSwitch Method

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: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea

C#

void SetSwitch(
	short id,
	bool state
)

VB

Sub SetSwitch ( 
	id As Short,
	state As Boolean
)

Parameters

id Int16: The device number (0 to MaxSwitch - 1)
state Boolean: The required control state

Remarks

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

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.

Version Information

.NET Standard

Supported in: 2.0