IAscomDeviceCommandBool Method

Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
bool CommandBool(
	string command,
	bool raw = false
)

Parameters

command  String
The literal command string to be transmitted.
raw  Boolean  (Optional)
if set to true the string is transmitted 'as-is'. If set to false then protocol framing characters may be added prior to transmission.

Return Value

Boolean
Returns the interpreted boolean response received from the device.

Remarks

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

Please Note: The Camera definition in the link applies to all device types.

Exceptions

NotImplementedExceptionIf the method is not implemented
NotConnectedExceptionIf the driver is not connected.
DriverExceptionAn 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

See Also