Percent conpleted, Interface Version 2 only

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
short PercentCompleted { get; }
Visual Basic
ReadOnly Property PercentCompleted As Short
	Get
Visual C++
property short PercentCompleted {
	short get ();
}

Return Value

A value between 0 and 100% indicating the completeness of this operation

Remarks

May throw a PropertyNotImplementedException if PercentCompleted is not supported by the camera.

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

Exceptions

ExceptionCondition
PropertyNotImplementedExceptionMust throw an exception if PercentCompleted is not supported
InvalidOperationExceptionThrown when it is inappropriate to call PercentCompleted

See Also