Click or drag to resize

ITelescopeV3Action Method

Invokes the specified device-specific custom action.

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
string Action(
	string ActionName,
	string ActionParameters
)

Parameters

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

Return Value

Type: 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
ExceptionCondition
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.
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.

See Also