com.esri.arcgis.geodatabase
Interface ICancelOperation

All Superinterfaces:

Serializable

All Known Implementing Classes:

ICancelOperationProxy

public interface ICancelOperation
extends Serializable

Provides access to members that indicate if an operation has been cancelled.

Description

ICancelOperation can be implemented by custom classes in order to provide cancellation functionality to long operations, particularly those on the IFeatureConstruction interface. Several methods on that interface accept an ICancelOperation parameter (which is often left null); if a custom class that implements this interface is passed in as that parameter, changes to that class which modify the return value of the IsCancelled property to True will allow the operations to be cancelled (with an error being raised by the operation).

Remarks

Passing an object that implements this interface to a long operation is only useful in a multithreaded application. Calls to long operations, such as those defined by IFeatureConstruction, are blocking and a different thread is required to trigger the cancel operation on the custom object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean

isCancelled() Indicates if the operation has been cancelled.

Method Detail

isCancelled

boolean isCancelled()
                    throws IOException,
                           AutomationException

Indicates if the operation has been cancelled.

Description

Returns whether or not the operation is cancelled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The isCancelled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.