AscomDriverAction Method

Invokes the specified device-specific custom action.

Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 7.0.0-rc.0+0

Syntax

public string Action(
	string ActionName,
	string ActionParameters
)

Public Function Action ( 
	ActionName As String,
	ActionParameters As String
) As String

public:
virtual String^ Action(
	String^ ActionName, 
	String^ ActionParameters
) sealed

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.

Exceptions

Exception	Condition
MethodNotImplementedException	Thrown if no actions are supported.
ActionNotImplementedException	It 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.
NotConnectedException	If the device is not connected
DriverException	An error occurred that is not described by one of the more specific ASCOM exceptions. The device did not successfully complete the request.

Remarks

Must be implemented.

Action names are case insensitive, so SelectWheel, selectwheel and SELECTWHEEL all refer to the same action.

The names of all supported actions must be returned in the SupportedActions property.

Reference

AscomDriver Class

ASCOM.DriverAccess Namespace