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
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
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
| 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
| CoClasses and Classes | Description |
|---|---|
| ExportWebMap | Export WebMap to a specified format based on potential layout provided. |
| FMEExportFunction (esriDataInterop) | FMEExportFunction Class |
| FMEImportFunction (esriDataInterop) | FMEImportFunction Class |
| GPConvertCacheStorageFormat | Convert storage format of pre-rendered tile cache for the MapServer. |
| GPConvertCacheStorageFormatWorker | Convert storage format of pre-rendered tile cache for the MapServer. |
| GPConvertMapServerCacheStorageFormat | Convert map cache storage format. |
| GPCreateMapServerCache | Create pre-rendered tile cache for the MapServer. |
| GPDeleteGlobeCache (esriGlobeCore) | Delete pre-rendered tile cache for the GlobeServer. |
| GPDeleteGlobeServerCache (esriGlobeCore) | Delete pre-rendered tile cache for the GlobeServer. |
| GPDeleteMapServerCache | Delete pre-rendered tile cache for the MapServer. |
| GPESRIAvailableFonts | Reports the available fonts on the server |
| GPExportCache | Export pre-rendered tile cache. |
| GPExportCacheWorker | Export pre-rendered tile cache worker. |
| GPExportMapServerCache | Export Map Server Cache. |
| GPExportToKML (esriGlobeCore) | . |
| GPGenerateGlobeServerCache (esriGlobeCore) | Generate pre-rendered tile cache for the GlobeServer. |
| GPGenerateMapServerCache | Generate pre-rendered tile cache for the MapServer. |
| GPGenerateMapServerCacheTilingScheme | Generate Map Server Cache Tiling Scheme. |
| GPImportCache | Import pre-rendered tile cache. |
| GPImportCacheWorker | Import pre-rendered tile cache worker. |
| GPImportMapServerCache | Import Map Server Cache. |
| GPKMLToLayer (esriGlobeCore) | . |
| GPLayersToKML (esriGlobeCore) | . |
| GPManageGlobeCache (esriGlobeCore) | Update pre-rendered tile cache for the GlobeServer. |
| GPManageGlobeCacheWorker (esriGlobeCore) | Update pre-rendered tile cache for the GlobeServer. |
| GPManageMapCacheScales | Manage pre-rendered tile cache scales for the Map. |
| GPManageMapServerCacheTiles | Manage pre-rendered tile cache for the MapServer. |
| GPMultipatchToCollada (esriGlobeCore) | . |
| GPReportCacheStatus | Report status information for cached services |
| GPServerCachingCreateMapCache | Create pre-rendered tile cache for the MapServer. |
| GPServerCachingDeleteMapCache | Delete pre-rendered tile cache for the MapServer. |
| GPServerCachingManageMapCacheTiles | Manage pre-rendered tile cache for the Map. |
| GPServerCachingManageMapCacheTilesWorker | Manage pre-rendered tile cache for the Map. |
| GPServerCachingValidateMapCacheTiles | Validate pre-rendered tile cache for the Map. |
| GPServerCachingValidateMapCacheTilesWorker | Validate pre-rendered tile cache for the Map. |
| GPSuggestDefaultScales | Suggest pre-rendered tile cache scales for the Map. |
| GPUpdateGlobeServerCache (esriGlobeCore) | Update pre-rendered tile cache for the GlobeServer. |
| GPUpdateGlobeServerCache2 (esriGlobeCore) | Update pre-rendered tile cache for the GlobeServer. |
| GPUpdateMapServerCache | Update pre-rendered tile cache for the MapServer. |
| GPUpdateMapServerCacheScales | Update Map Server Cache Tiling Scales. |
| GPValidateMapServerCacheTiles | Manage pre-rendered tile cache for the MapServer. |
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.