CameraPercentCompleted Property |
Percent completed, Interface Version 2 or later
Namespace: ASCOM.DriverAccess
Assembly: ASCOM.DriverAccess (in ASCOM.DriverAccess.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
SyntaxReturn Value
Type: Int16A value between 0 and 100% indicating the completeness of this operation
Implements
ICameraV3PercentCompletedExceptions| Exception | Condition |
|---|---|
| PropertyNotImplementedException | Must throw an exception if PercentCompleted is not supported |
| InvalidOperationException | Thrown when it is inappropriate to call PercentCompleted |
| 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
If valid, returns an integer between 0 and 100, where 0 indicates 0% progress (function just started) and
100 indicates 100% progress (i.e. completion).
At the discretion of the driver author, PercentCompleted may optionally be valid when CameraState is in any or all of the following states: cameraExposing, cameraWaiting, cameraReading or cameraDownload. In all other states an exception shall be thrown.
Typically the application user interface will show a progress bar based on the PercentCompleted value.
Please note that client applications are not required to use this value, and in some cases may display status information based on other information, such as time elapsed.
This is only available for the Camera Interface Version 2
See Also