com.esri.arcgis.geoprocessing
Interface IGPFunctionTool

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGPFunctionToolProxy

public interface IGPFunctionTool
extends Serializable

Provides access to methods on a geoprocessing function tool object.

Product Availability

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

Method Summary

IGPFunction	getFunction() The function object associated with the tool.
void	setFunctionByRef(IGPFunction function) The function object associated with the tool.

Method Detail

getFunction

IGPFunction getFunction()
                        throws IOException,
                               AutomationException

The function object associated with the tool.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionByRef

void setFunctionByRef(IGPFunction function)
                      throws IOException,
                             AutomationException

The function object associated with the tool.

Product Availability

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

Parameters:

function - A reference to a com.esri.arcgis.geoprocessing.IGPFunction (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.