ENVIServer::SubmitTask

The SubmitTask method submits an ENVITask for execution on a specified ENVIServer.

Example

; Start the application

e = ENVI(/HEADLESS)

; Define a task and populate input parameters

File = Filepath('qb_boulder_msi', Subdir=['data'], $

  Root_Dir=e.Root_Dir)

Raster = e.OpenRaster(File)

Task = ENVITask('ISODATAClassification')

Task.INPUT_RASTER = Raster

; Define a server

Server = ENVIServer('localhost')

; Submit the task to run ansynchronously

Job = Server.SubmitTask(Task)

Syntax

Result = ENVIServer.SubmitTask(Task [, Keywords=value])

Return Value

This method returns a job ID.

Arguments

Task

Specify an ENVITask to run.

Keywords

ERROR (optional)

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

REGISTER (optional)

Set this keyword to add the task (job) to the ENVI Server Job Console. By default, the task will be added. If ENVI is running in headless mode, this keyword is ignored.

Version History

ENVI 5.6

Introduced

API Version

4.2