com.esri.arcgis.geoprocessing
Interface IGPComHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

GpDispatch

public interface IGPComHelper
extends Serializable

Provides access to properties and methods on a Geoprocessing helper object.

Remarks

The IGPComHelper interface provides access to the properties and methods of the GPComHelper object. It is mainly intended for C++ developers to easily execute geoprocessing functions. Use this interface to invoke/create a GPEnvironmentManager object. With ArcGIS 9.2, C++ developers are now recommended to use the new Geoprocessor class.

See also IGeoprocessor

Product Availability

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

Method Summary

void	addToolbox(String toolbox) Adds a reference to the specified toolbox to the GeoProcessor.
IGPMessages	execute(String toolName, IPropertySet params, ITrackCancel trackCancel) Executes the specified tool.
IGPEnvironmentManager	getEnvironmentManager() The environment manager object associated with the helper.
String	getParameterName(String toolName, int index) Get the parameter name for a given tool and index.
void	removeToolbox(String toolbox) Removes the reference to the specified toolbox from the GeoProcessor.

Method Detail

execute

IGPMessages execute(String toolName,
                    IPropertySet params,
                    ITrackCancel trackCancel)
                    throws IOException,
                           AutomationException

Executes the specified tool.

Product Availability

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

Parameters:

toolName - The toolName (in)

params - A reference to a com.esri.arcgis.system.IPropertySet (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameterName

String getParameterName(String toolName,
                        int index)
                        throws IOException,
                               AutomationException

Get the parameter name for a given tool and index.

Product Availability

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

Parameters:

toolName - The toolName (in)

index - The index (in)

Returns:

The paramName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToolbox

void addToolbox(String toolbox)
                throws IOException,
                       AutomationException

Adds a reference to the specified toolbox to the GeoProcessor.

Product Availability

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

Parameters:

toolbox - The toolbox (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeToolbox

void removeToolbox(String toolbox)
                   throws IOException,
                          AutomationException

Removes the reference to the specified toolbox from the GeoProcessor.

Product Availability

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

Parameters:

toolbox - The toolbox (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws IOException,
                                                   AutomationException

The environment manager object associated with the helper.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.