In this topic

• Geoprocessing
• Background geoprocessing
• Submitting a tool
• Checking tool execution status
  • Geoprocessor events
  • ToolExecuting event
  • ProgressChanged event
  • ToolExecuted event
  • IGeoProcessorResult
• Canceling a tool
• Layer and data usage during tool execution
• Edit sessions and background geoprocessing
  • Start editing then execute in the background
  • Execute in the background then start editing

Geoprocessing

Background geoprocessing

• Submitting the tool for execution.
• Checking the tool's execution status.

Submitting a tool

[C#]

ESRI.ArcGIS.Geoprocessor.Geoprocessor gp = new ESRI.ArcGIS.Geoprocessor.GeoProcessor();
gp.OverwriteOutput = true;
//Register to receive the geoprocessor event when the tools have completed execution.
gp.ToolExecuted += new EventHandler < ESRI.ArcGIS.Geoprocessor.ToolExecutedEventArgs> (gpToolExecuted);
IGeoProcessorResult2 gpResult = gp.ExecuteAsync("CopyFeatures", parameters)asIGeoProcessorResult2;

Checking tool execution status

• Register and listen for the Geoprocessor.ToolExecuted events and, optionally, the other events (this is the most common option).
• Periodically query IGeoprocessorResult.

Geoprocessor events

• The ToolExecuting event is fired by all tools before a tool is taken from the geoprocessing queue and executed in the background. At this time, the tool's IGeoProcessorResult.Status property is still esriJobStatus.esriJobWaiting.
• The MessagesCreated event and the ProgressChanged event can fire during tool execution. These events fire depending on which tool is executing and how much data the tool is processing.
• The ToolExecuted event is fired by all tools when background execution has stopped.

ToolExecuting event

[C#]

public void gpToolExecuting(object sender, ToolExecutingEventArgs e)
{IGeoProcessorResult2 result = e.GPResult as IGeoProcessorResult2;//Determine if this is the tool to handle this event.if (result.Process.Tool.Name.Equals("CopyFeatures") && result.GetInput(0).GetAsText().Equals(@"c:\Europe_Roads\Europe_Roads") && result.GetOutput(0).GetAsText().Equals(@"c:\Europe_Roads\Europe_Roads_Copy")){//Application specific code.}
}

ProgressChanged event

[C#]

public void gpProgressChanged(object sender, ProgressChangedEventArgs e)
{System.Windows.Forms.ProgressBar progressBar = myProgressBar;IGeoProcessorResult2 gpResult = (IGeoProcessorResult2)e.GPResult;switch (e.ProgressChangedType){case (ProgressChangedType.Show): //The tool that is running reports progress or has stopped reporting progress; make the // progress bar visible if appropriate. progressBar.Visible = e.Show;break;case (ProgressChangedType.Message): //The application does not use these, since a tool being used reports percentage progress.break;case (ProgressChangedType.Percentage): progressBar.Value = (int)e.ProgressPercentage;break;default:throw new ApplicationException("unexpected ProgressChangedEventsArgs.ProgressChangedType");break;}
}

ToolExecuted event

[C#]

public void gpToolExecuted(object sender, ToolExecutedEventArgs e)
{IGeoProcessorResult2 result = e.GPResult as IGeoProcessorResult2;if (result.Status.Equals(esriJobStatus.esriJobSucceeded)){//Check that there are no information or warning messages.if (result.MaxSeverity == 0){//Get the return value.object returnValue = result.ReturnValue;//Application specific code, //for example, find the layer to which this return value corresponds.}else{//Application specific code.}}else{//Get all messages.IGPMessages msgs = result.GetResultMessages();for (int i = 0; i < result.MessageCount; i++){IGPMessage2 msg = msgs.GetMessage(i)as IGPMessage2;//Application specific code.}}
}

IGeoProcessorResult

Canceling a tool

Layer and data usage during tool execution 

• Changing the visibility, select ability, and connection details of a layer input to or output from an executing geoprocessing tool.
• Searching and selecting data input to a geoprocessing tool, for example, using the IFeatureLayer.Search and IFeatureClass.Select methods.

• Editing table rows of input or output data in or out of an edit session.
• Using the IFeatureLayer.Search and IFeatureClass.Select methods on output data. The set of table rows returned is undefined, since the table is in the process of being populated.

Edit sessions and background geoprocessing

Start editing then execute in the background

[C#]

public void gpToolExecuting(object sender, ToolExecutingEventArgs e)
{IGeoProcessorResult2 result = e.GPResult as IGeoProcessorResult2;//Get the single feature class input parameter.IGPParameter parameter = result.Process.InputParameters.get_Element(0)asIGPParameter;string parameterPath = "";if (parameter.DataType.DisplayName.Equals("FeatureClass")){parameterPath = parameter.Value.GetAsText();}//Check whether this dataset is being edited.ESRI.ArcGIS.Controls.EngineEditor engineEditor = newESRI.ArcGIS.Controls.EngineEditor();if (engineEditor.EditState == esriEngineEditState.esriEngineStateEditing &&engineEditor.EditWorkspace != null){IEnumDatasetName datasetNames = engineEditor.EditWorkspace.get_DatasetNames(esriDatasetType.esriDTAny);IDatasetName name = datasetNames.Next();while (name != null){string path = engineEditor.EditWorkspace.PathName + @"\" + name.Name;if (path.Equals(parameterPath)){//This datset is being edited. Prompt the user to stop editing.}}}
}

Execute in the background then start editing

See Also:

How to run a geoprocessing tool
How to work with geoprocessing services
Geoprocessing
Using geoprocessing

• ESRI.ArcGIS.Geoprocessing
• ESRI.ArcGIS.Geoprocessor
• ESRI.ArcGIS.Geodatabase