ASCOMDeviceAction Method

Invokes the specified device-specific action.

Definition

Namespace: ASCOM.Com.DriverAccess
Assembly: ASCOM.Com (in ASCOM.Com.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
public 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.

Implements

IAscomDeviceAction(String, String)

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

NotImplementedExceptionThrows this exception if an action name is not supported. of driver capabilities, but the driver must still throw an ASCOM.ActionNotImplemented exception if it is asked to perform an action that it does not support.
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.
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.

Version Information

.NET Standard

Supported in: 2.0

See Also