com.esri.arcgis.geoprocessing
Interface IGeoProcessorEvents

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGeoProcessorEventsProxy

public interface IGeoProcessorEvents
extends Serializable

Provides access to GeoProcessor events.

Superseded By

IGeoProcessorEvents2

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(IGPTool tool, IArray values, long result, IGPMessages messages) Called immediately after a tool is executed by the GeoProcessor.
void	preToolExecute(IGPTool tool, IArray values, int processID) 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.

Supported Platforms

Windows

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(IGPTool tool,
                    IArray values,
                    int processID)
                    throws IOException,
                           AutomationException

Called immediately prior to the GeoProcessor executing a tool.

Product Availability

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

Supported Platforms

Windows

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

values - A reference to a com.esri.arcgis.system.IArray (in)

processID - The processID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postToolExecute

void postToolExecute(IGPTool tool,
                     IArray values,
                     long result,
                     IGPMessages messages)
                     throws IOException,
                            AutomationException

Called immediately after a tool is executed by the GeoProcessor.

Product Availability

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

Supported Platforms

Windows

Parameters:

tool - A reference to a com.esri.arcgis.geoprocessing.IGPTool (in)

values - A reference to a com.esri.arcgis.system.IArray (in)

result - An error code (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (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.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.