ISwitchV2SetSwitch Method

Sets a switch controller device to the specified state, true or false.

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484

Syntax

C++

Copy

void SetSwitch(
	short id,
	bool state
)

Sub SetSwitch ( 
	id As Short,
	state As Boolean
)

void SetSwitch(
	short id, 
	bool state
)

Parameters

id: Type: SystemInt16
The device number (0 to MaxSwitch - 1)
state: Type: SystemBoolean
The required control state

Exceptions

Exception	Condition
InvalidValueException	If id is outside the range 0 to MaxSwitch - 1
MethodNotImplementedException	If CanWrite(Int16) is false.
NotConnectedException	If the device is not connected
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.

Remarks

Can throw a MethodNotImplementedException 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

Reference

ISwitchV2 Interface

ASCOM.DeviceInterface Namespace

ISwitchV2AddLanguageSpecificTextSet("LSTA168D29F_0?cpp=::|nu=.");SetSwitch Method

Parameters

Reference

ISwitchV2SetSwitch Method