IGPFunction Interface

Provides access to the properties/methods of a geoprocessing function object. Note: the IGPFunction interface has been superseded byIGPFunction2. Please consider using the more recent version.

Product Availability

When To Use

IGPFunction is used to obtain access to the properties and methods required to build a function tool. For additional use information check the interface's individual properties and methods and the Building Geoprocessing Function Tools.

Members

	All Properties Methods	Description
	DialogCLSID	The class identifier (CLSID) of the custom dialog object to use when invoking the geoprocessing function.
	DisplayName	Displayed name of the geoprocessing function.
	Execute	Executes the geoprocessing function using the given array of parameter values.
	FullName	The function name object of the geoprocessing function.
	GetRenderer	Returns the custom renderer to use for the specified parameter.
	HelpContext	The context identifier of the topic within the help file for this function object.
	HelpFile	Name of the (CHM) file containing help information for this function object.
	IsLicensed	Returns whether the geoprocessing function has all necessary licenses in order to execute.
	MetadataFile	Name of the (XML) file containing the default metadata for this function object.
	Name	Name of the geoprocessing function.
	ParameterInfo	The list of parameters accepted by the geoprocessing function.
	Validate	Validates the given array of parameter values.

CoClasses that implement IGPFunction

Remarks

To create a geoprocessing function tool requires the implementation of at least two objects: One is a function object that implements the IGPFunction interface; the other one is a function factory object that implements the IGPFunctionFactory interface. The IGPFunction interface provides access to properties and methods needed to build a function tool.