ENVIAbortableTaskFromProcedure

Use this class If you are writing a custom task and want to include a progress bar with an option to abort the process. Set the base_class key in the task template to ENVIAbortableTaskFromProcedure.

In the user-defined IDL procedure that contains the data-processing code, set the ABORTABLE keyword to ENVIStartMessage. When ENVITask::Execute is called on the custom task, an ENVIAbortable object is automatically created that sends an abort message to the user interface if the end user clicks the Cancel button on the progress dialog.

Note: The IDL procedure must use only keywords, not positional parameters.

Methods

PreExecute

DoExecute

PostExecute

Properties

ENVIAbortableTaskFromProcedure inherits all properties from ENVITask.

Version History

ENVI 5.3

Introduced

API Version

4.2

See Also

ENVITask, ENVITaskFromProcedure, Custom Tasks, Messaging