IRotatorV4Action Method

Invokes the specified device-specific custom action.

Definition

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
string Action(
	string ActionName,
	string ActionParameters
)

Parameters

ActionName  String
A well known name agreed by interested parties that represents the action to be carried out.
ActionParameters  String
List of required parameters or an Empty String if none are required.

Return Value

String
A string response. The meaning of returned strings is set by the driver author.

Suppose filter wheels start to appear with automatic wheel changers; new actions could be QueryWheels and SelectWheel. The former returning a formatted list of wheel names and the second taking a wheel name and making the change, returning appropriate values to indicate success or failure.

Remarks

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

Exceptions

MethodNotImplementedExceptionThrown if no actions are supported.
ActionNotImplementedExceptionIt is intended that the SupportedActions method will inform clients of driver capabilities, but the driver must still throw an ActionNotImplementedException exception if it is asked to perform an action that it does not support.
NotConnectedExceptionIf the device 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.

Revision History

DateVersionDescription
IRotatorV2Platform 6.0Member added.

See Also