ISwitchV3CanWrite Method

Reports if the specified switch device can be written to, default true. This is false if the device cannot be written to, for example a limit switch or a sensor.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b

C#

bool CanWrite(
	short id
)

VB

Function CanWrite ( 
	id As Short
) As Boolean

C++

bool CanWrite(
	short id
)

Parameters

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

Return Value

Boolean
true if the device can be written to, otherwise false.

Remarks

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

Exceptions

InvalidValueException	If id is outside the range 0 to MaxSwitch - 1
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.

Revision History

Date	Version	Description
ISwitchV2	Platform 6.1	Member added.