Execute an asynchronous geoprocessing tool.
SubmitJob(string ToolName, GPValue[] Values)
|
Parameter |
Description |
|
ToolName |
The name of a server tool in a geoprocessing service.
|
|
Values
|
An array of GPValue instances, one for each input to the tool. |
|
Options |
A GPResultOptions instance defining how the
result values are returned. Can be null.
If specified, results are modified using these options during tool execution.
|
|
EnvironmentValues |
A PropertySet of name value pairs which can be used to modify tool execution. Can be null. Environment values can be general or specific to the operations within the tool.
|
Return Value
A string defining the job id.
Remarks
The arguments for SubmitJob() are the same
as Execute(). A job id is returned as soon as the
job is submitted. A client can use GetJobStatus()
to check the status of the job and GetJobResult() to get the job results.
Use GetToolInfo() to determine the input
values for the tool. Each tool parameter has a
direction indicating input or output. SubmitJob()
and Execute() only require input parameters.
Environment values can be general or specific to the operations (tools)
within the server tool. General environment values
apply to all operations. Specific environment
values only affect specific operations. By
default, the server tool does not provide information on the operations
it contains, only the input and output types. The
service publisher must provide information on the operations within the
tool for consumers to know which environment values are valid. See
the Environment Settings topic in the ArcGIS Desktop help
for geoprocessing tools (tools within a server tool).
Examples