com.esri.arcgis.geoprocessing
Interface IGeoProcessorEvents2

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGeoProcessorEvents2Proxy

public interface IGeoProcessorEvents2
extends Serializable

Provides access to GeoProcessor events2.

Description

This interface is new at ArcGIS 9.3. It supersedes IGeoProcessorEvents.

Product Availability

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


Method Summary
 void onMessageAdded(IGPMessage message)
          Called when a message has been posted while executing a tool.
 void postToolExecute(long result, IMdProcess process)
          Called immediately after a tool is executed by the GeoProcessor.
 void preToolExecute(IMdProcess process)
          Called immediately prior to the GeoProcessor executing a tool.
 void toolboxChange()
          Called when a toolbox is added or removed from the GeoProcessor.
 

Method Detail

onMessageAdded

void onMessageAdded(IGPMessage message)
                    throws IOException,
                           AutomationException
Called when a message has been posted while executing a tool.

Product Availability

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

Parameters:
message - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

preToolExecute

void preToolExecute(IMdProcess process)
                    throws IOException,
                           AutomationException
Called immediately prior to the GeoProcessor executing a tool.

Product Availability

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

Parameters:
process - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postToolExecute

void postToolExecute(long result,
                     IMdProcess process)
                     throws IOException,
                            AutomationException
Called immediately after a tool is executed by the GeoProcessor.

Product Availability

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

Parameters:
result - An error code (in)
process - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toolboxChange

void toolboxChange()
                   throws IOException,
                          AutomationException
Called when a toolbox is added or removed from the GeoProcessor.

Product Availability

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.