IVideoV2Connected Property

Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
bool Connected { get; set; }

Property Value

Boolean
true if connected to the hardware; otherwise, false.

Remarks

Must be implemented

Do not use a NotConnectedException here. That exception is for use in other methods that require a connection in order to succeed.

The Connected property sets and reports the state of connection to the device hardware. For a hub this means that Connected will be true when the first driver connects and will only be set to false when all drivers have disconnected. A second driver may find that Connected is already true and setting Connected to false does not report Connected as false. This is not an error because the physical state is that the hardware connection is still true.

Multiple calls setting Connected to true or false will not cause an error.

ICameraV4 Behaviour Clarification - IVideoV2 and later clients should use the asynchronous Connect / Disconnect mechanic rather than setting Connected when communicating with IVideoV2 or later devices.

Exceptions

DriverExceptionMust throw an exception if the call was not successful

Revision History

DateVersionDescription
IVideoPlatform 6.1Member added.
IVideoV2Platform 7.0Clients should use the Connect() / Disconnect() mechanic rather than setting Connected TRUE when accessing IVideoV2 or later devices.

See Also