This document is archived and information here might be outdated.  Recommended version.


IGPUtilities Interface (ArcObjects .NET 10.7 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Geoprocessing > ESRI.ArcGIS.Geoprocessing > Interfaces > IG > IGPUtilities Interface
ArcGIS Developer Help

IGPUtilities Interface

Provides access to the properties/methods of a geoprocessing utilities object. Note: the IGPUtilities interface has been superseded by IGPUtilities2. Please consider using the more recent version.

Product Availability

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

Members

Name Description
Method AddInternalLayer Adds a layer object to the geoprocessing utility object.
Method AddInternalLayer2 Adds a layer object and geoprocessing layer object to the geoprocessing utility object.
Method AddInternalTable Adds the given table to the utility object's list of tables.
Method AddInternalTable2 Adds the given table to the utility object's list of tables.
Method AddToMap Adds the given geoprocessing value object to the application display.
Method CanAddToMap Returns whether datasets can be added to the current application display.
Read-only property Catalog Returns the catalog object shared between geoprocessing operations.
Method CompareWildCard Returns whether the given string satisfies the given wildcard string.
Method Copy Copies the object referred to by the given geoprocessing value object.
Method CreateDataElement Creates a new data element object from the catalog object specified by the given path, data type, and optional workspace.
Method CreateFeatureClassName Creates a feature class name object from the given catalog path.
Method CreateFeatureLayer Creates a geoprocessing feature layer object from the catalog path.
Method CreateParameterValue Creates a geoprocessing value object of the given data type from the given string.
Method CreateParentFromCatalogPath Returns a name object corresponding to the parent object of the specified catalog path.
Method CreateRasterCatalogName Creates a raster catalog name object from the given catalog path.
Method CreateRasterDatasetName Creates a raster dataset name object from the given catalog path.
Method CreateTableName Creates a table name object from the given catalog path.
Method CreateTableNameEx Creates a table name object from the given catalog path; optionally deals with feature service urls.
Method DecodeDETable Returns the table data element specified by the given geoprocessing value object.
Method DecodeFeatureLayer Returns the feature class and query filter specified by the given geoprocessing value object.
Method DecodeLayer Returns the layer object specified by the given geoprocessing value object.
Method DecodeRaster Returns the raster specified by the given geoprocessing value object.
Method DecodeRasterLayer Returns the raster dataset specified by the given geoprocessing value object.
Method DecodeStandaloneTable Returns the standalone table object specified by the given geoprocessing value object.
Method DecodeTableView Returns the table and query filter specified by the given geoprocessing value object.
Method Delete Deletes the object referred to by the given geoprocessing value object.
Method Exists Returns whether the object referred to by the given geoprocessing value object exists.
Method ExpandDataElement Expands the properties of the given data element according to the given expand options.
Method ExportFeatureClass Exports the given feature class to a new feature class.
Method FieldExists Returns whether the given field exists within the given geoprocessing value object.
Method FindField Returns the field object with the specified name in the given geoprocessing value object.
Method FindMapLayer Returns a layer with the given name.
Method FindMapLayer2 Returns a layer and geoprocessing layer with the given name.
Method FindMapTable Locates a table with the specified name.
Method FindMapTable2 Locates a table with the specified name and returns the table and geoprocessing table view objects.
Method GenerateDefaultOutputValue Generates the default output value and sets its path to an unique name.
Method GenerateSpRef Generates a new spatial reference object.
Method GetEnvironment Locates a geoprocessing environment with the given name in the given array.
Method GetFields Returns a collection of field objects contained in the given geoprocessing value object.
Method GetGPLayers Returns an enumeration of current geoprocessing layers.
Method GetGPMapData Returns an enumeration of geoprocessing data.
Method GetGPSpRefEnv Creates the spatial reference from both a source and environment.
Method GetGPTableViews Returns an enumeration of geoprocessing table views.
Method GetGxObject Returns the catalog object corresponding to the given data element.
Method GetGxObjectFromLocation Returns the catalog object from the given catalog path.
Method GetGxObjects Returns an array of all catalog objects which correspond to the catalog path.
Method GetMapLayers Returns an enumeration of the current layers in the application.
Method GetMapTables Returns an enumeration of standalone tables in the current map.
Method GetNameObject Returns a name object corresponding to the object referred to by the given data element.
Method GetNameObjectFromLocation Returns a name object corresponding to the object by the location moniker.
Method GetUnQualifiedCatalogPath Returns the unqualified path by striping the GDBs database and user names.
Method InternalValidate Performs a validation of the parameters to a GPTool.
Method InternalValidateValue Performs a validation of the a single parameter to a GPTool.
Method IsBadMessage Tests if a given message within an array of messages is bad.
Method IsDatasetType Returns whether the given object is a dataset.
Method IsDerived Returns whether the given variable or parameter is derived.
Method IsGPTableView Returns test if a geoprocessing table views is in fact a table and not from a layer.
Method MakeDataElement Returns a data element object from the catalog object specified by the given path, data type, and expand options.
Method MakeDataElementFromNameObject Creates a new data element object from the given name object.
Method MakeDataElements Get data elements from catalog path.
Method MakeGPLayer Creates a geoprocessing layer object from the given catalog path and of the given geoprocessing data type.
Method MakeGPLayerFromLayer Creates a geoprocessing layer object based on the given layer object.
Method MakeGPTableView Returns a geoprocessing table view object corresponding to the given catalog path and of the specified geoprocessing data type.
Method MakeGPTableViewFromTable Returns a new geoprocessing table view object from the given table object.
Method MakeGPValueFromObject Generate an GPValue from an Arc Object.
Method OpenDataset Opens the dataset object specified by the given geoprocessing value object.
Method OpenDatasetFromLocation Opens the dataset object from the given catalog path.
Method OpenFeatureClassFromString Opens a feature class from the given catalog path.
Method OpenFeatureLayerFromString Opens a feature layer from the given catalog path.
Method OpenRasterDatasetFromString Opens a raster dataset object from the given catalog path.
Method OpenRasterLayerFromString Opens a raster layer object from the given catalog path.
Method OpenTableFromString Opens a table from the given catalog path.
Method PackGPValue Sets the given geoprocessing value into the given parameter/variable.
Method QualifyOutputCatalogPath Qualify the catalog path with the GDBs database and user names.
Method QualifyOutputDataElement Qualify the catalog path of the given value with the GDBs database and user names.
Method RefreshCatalog Refreshes the parent within the catalog of the given data element.
Read/write property RefreshCatalogParent Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.
Method RefreshView Refreshes the applications active view.
Method ReleaseInternals Releases all internal objects used prior to releasing this GPUtilities object.
Method RemoveFromMap Removes the data/layers specified by the geoprocessing value object and/or name.
Method RemoveInternalLayer Removes the internal layer.
Method RemoveInternalLayerEx Removes the internal layer.
Method RemoveInternalTable Removes the internal table.
Method RemoveInternalTableEx Removes the internal table.
Method RemoveInternalValues Removes all of the GPValues returned from MakeGPValueFromObject.
Method Rename Renames the object referred to by the given geoprocessing value object.
Method SetGridIndex Calculates and sets the grid index sizes on the given geometry definition object.
Method UnpackGPValue Returns the geoprocessing value object from the given parameter, variable, or value object.
Method ValidateExists Verifies that the data referenced by the given geoprocessing value object exists.
Read/write property Workspace Sets the path to the current workspace.

Classes that implement IGPUtilities

Classes Description
GPUtilities Helper object with common geoprocessing utility methods.

Remarks

The IGPUtilities interface provides access to the GPUtilities object which contains many useful helper methods and properties to provide easier access to other ArcObjects. For example, the OpenFeatureClassFromString method can create an IFeatureClass object by simply providing the ArcCatalog path as a string.

The GPUtilities object is mainly intended for developers building custom tools. For more information about building custom tools, refer to the technical document Building Geoprocessing Function Tools .

.NET Samples

Geoprocessing field mapping