com.esri.arcgis.geoprocessing
Interface IGPUtilities

All Superinterfaces:

Serializable

All Known Subinterfaces:

IGPUtilities2, IGPUtilities3, IGPUtilities4

All Known Implementing Classes:

GPUtilities

public interface IGPUtilities
extends Serializable

Provides access to the properties/methods of a geoprocessing utilities object.

Superseded By

IGPUtilities2

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 .

Product Availability

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

Method Summary

void	addInternalLayer(ILayer pLayer) Adds a layer object to the geoprocessing utility object.
void	addInternalLayer2(ILayer pLayer, IGPLayer pGPLayer) Adds a layer object and geoprocessing layer object to the geoprocessing utility object.
void	addInternalTable(ITable pTable) Adds the given table to the utility object's list of tables.
void	addInternalTable2(ITable pTable, IGPTableView pGPTableView) Adds the given table to the utility object's list of tables.
void	addToMap(IGPValue pGPValue, String name, boolean temporary, Object pUnkRenderer) Adds the given geoprocessing value object to the application display.
boolean	canAddToMap() Returns whether datasets can be added to the current application display.
boolean	compareWildCard(String wildCard, String data) Returns whether the given string satisfies the given wildcard string.
void	copy(IGPValue pSourceGPValue, IGPValue pTargetGPValue) Copies the object referred to by the given geoprocessing value object.
IDataElement	createDataElement(String catalogPath, IGPDataType pDataType, String optionalWorkspace) Creates a new data element object from the catalog object specified by the given path, data type, and optional workspace.
IName	createFeatureClassName(String catalogPath) Creates a feature class name object from the given catalog path.
IGPValue	createFeatureLayer(String catalogPath) Creates a geoprocessing feature layer object from the catalog path.
IGPValue	createParameterValue(String text, IGPDataType pDataType, int direction) Creates a geoprocessing value object of the given data type from the given string.
IName	createParentFromCatalogPath(String catalogPath) Returns a name object corresponding to the parent object of the specified catalog path.
IName	createRasterCatalogName(String catalogPath) Creates a raster catalog name object from the given catalog path.
IName	createRasterDatasetName(String catalogPath) Creates a raster dataset name object from the given catalog path.
IName	createTableName(String catalogPath) Creates a table name object from the given catalog path.
IDETable	decodeDETable(IGPValue pValue) Returns the table data element specified by the given geoprocessing value object.
void	decodeFeatureLayer(IGPValue pValue, IFeatureClass[] ppFC, IQueryFilter[] ppQF) Returns the feature class and query filter specified by the given geoprocessing value object.
ILayer	decodeLayer(IGPValue pValue) Returns the layer object specified by the given geoprocessing value object.
IRaster	decodeRaster(IGPValue pValue) Returns the raster specified by the given geoprocessing value object.
void	decodeRasterLayer(IGPValue pValue, IRasterDataset[] ppRD) Returns the raster dataset specified by the given geoprocessing value object.
IStandaloneTable	decodeStandaloneTable(IGPValue pValue) Returns the standalone table object specified by the given geoprocessing value object.
void	decodeTableView(IGPValue pValue, ITable[] ppTable, IQueryFilter[] ppQF) Returns the table and query filter specified by the given geoprocessing value object.
void	delete(IGPValue pGPValue) Deletes the object referred to by the given geoprocessing value object.
boolean	exists(IGPValue pGPValue) Returns whether the object referred to by the given geoprocessing value object exists.
void	expandDataElement(IDataElement pInDE, IDEBrowseOptions pExpandOptions) Expands the properties of the given data element according to the given expand options.
void	exportFeatureClass(IDataElement pSourceDataElement, IDataElement pTargetDataElement) Exports the given feature class to a new feature class.
boolean	fieldExists(IGPValue pGPValue, IField pField) Returns whether the given field exists within the given geoprocessing value object.
IField	findField(IGPValue pGPValue, String name) Returns the field object with the specified name in the given geoprocessing value object.
ILayer	findMapLayer(String name) Returns a layer with the given name.
IGPLayer	findMapLayer2(String name, ILayer[] ppLayer) Returns a layer and geoprocessing layer with the given name.
ITable	findMapTable(String name) Locates a table with the specified name.
IGPTableView	findMapTable2(String name, ITable[] ppTable) Locates a table with the specified name and returns the table and geoprocessing table view objects.
IGPValue	generateDefaultOutputValue(IGPEnvironmentManager pEnvMgr, String functionname, IGPParameter pOutputParam, IGPValue pInputValue, String extension, int outputFileBaseLimit) Generates the default output value and sets its path to an unique name.
void	generateSpRef(IArray pInputTables, ITable pOverlayTable, double growExtentBy, ISpatialReference[] ppSpRef, IEnvelope[] ppExtent, boolean[] pHasMs, double[] pMMin, double[] pMMax, boolean[] pHasZs, double[] pZMin, double[] pZMax) Generates a new spatial reference object.
Object	getCatalog() Returns the catalog object shared between geoprocessing operations.
IGPEnvironment	getEnvironment(IArray pEnvironments, String name) Locates a geoprocessing environment with the given name in the given array.
IFields	getFields(IGPValue pValue) Returns a collection of field objects contained in the given geoprocessing value object.
IEnumGPValue	getGPLayers() Returns an enumeration of current geoprocessing layers.
IEnumGPValue	getGPMapData() Returns an enumeration of geoprocessing data.
ISpatialReference	getGPSpRefEnv(IGPEnvironmentManager pEnvMgr, ISpatialReference pSrcSpRef, IEnvelope pNewExtent, double newMMin, double newMMax, double newZMin, double newZMax, Object pWkspFDS) Creates the spatial reference from both a source and environment.
IEnumGPValue	getGPTableViews() Returns an enumeration of geoprocessing table views.
Object	getGxObject(IDataElement pDataElement) Returns the catalog object corresponding to the given data element.
Object	getGxObjectFromLocation(String catalogPath) Returns the catalog object from the given catalog path.
IArray	getGxObjects(String catalogPath) Returns an array of all catalog objects which correspond to the catalog path.
IEnumLayer	getMapLayers() Returns an enumeration of the current layers in the application.
IEnumTable	getMapTables() Returns an enumeration of standalone tables in the current map.
IName	getNameObject(IDataElement pDataElement) Returns a name object corresponding to the object referred to by the given data element.
IName	getNameObjectFromLocation(String locationMoniker) Returns a name object corresponding to the object by the location moniker.
String	getUnQualifiedCatalogPath(IGPValue pValue) Returns the unqualified path by striping the GDBs database and user names.
String	getWorkspace() Sets the path to the current workspace.
IGPMessages	internalValidate(IArray pParameters, IArray pParamValues, boolean updateValues, boolean honorDerivedFlag, IGPEnvironmentManager pEnvMgr) Performs a validation of the parameters to a GPTool.
void	internalValidateValue(IGPParameter pParameter, Object pValue, boolean updateValue, boolean honorDerivedFlag, IGPEnvironmentManager pEnvMgr, IGPMessage pMessage) Performs a validation of the a single parameter to a GPTool.
boolean	isBadMessage(IGPMessages pMessages, int index) Tests if a given message within an array of messages is bad.
boolean	isDatasetType(Object pUnknown) Returns whether the given object is a dataset.
boolean	isDerived(Object pInput) Returns whether the given variable or parameter is derived.
boolean	isGPTableView(IGPValue pValue) Returns test if a geoprocessing table views is in fact a table and not from a layer.
boolean	isRefreshCatalogParent() Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.
IDataElement	makeDataElement(String catalogPath, IGPDataType pDataType, IDEBrowseOptions pExpandOptions) Returns a data element object from the catalog object specified by the given path, data type, and expand options.
IDataElement	makeDataElementFromNameObject(IName name) Creates a new data element object from the given name object.
IArray	makeDataElements(String catalogPath, IDEBrowseOptions pBrowseOptions) Get data elements from catalog path.
IGPLayer	makeGPLayer(String catalogPath, IGPDataType pDataType) Creates a geoprocessing layer object from the given catalog path and of the given geoprocessing data type.
IGPLayer	makeGPLayerFromLayer(ILayer pLayer) Creates a geoprocessing layer object based on the given layer object.
IGPTableView	makeGPTableView(String catalogPath, IGPDataType pDataType) Returns a geoprocessing table view object corresponding to the given catalog path and of the specified geoprocessing data type.
IGPTableView	makeGPTableViewFromTable(ITable pTable) Returns a new geoprocessing table view object from the given table object.
IGPValue	makeGPValueFromObject(Object pUnk) Generate an GPValue from an Arc Object.
IDataset	openDataset(IGPValue pValue) Opens the dataset object specified by the given geoprocessing value object.
IDataset	openDatasetFromLocation(String catalogPath) Opens the dataset object from the given catalog path.
IFeatureClass	openFeatureClassFromString(String catalogPath) Opens a feature class from the given catalog path.
IFeatureLayer	openFeatureLayerFromString(String catalogPath) Opens a feature layer from the given catalog path.
IRasterDataset	openRasterDatasetFromString(String catalogPath) Opens a raster dataset object from the given catalog path.
IRasterLayer	openRasterLayerFromString(String catalogPath) Opens a raster layer object from the given catalog path.
ITable	openTableFromString(String catalogPath) Opens a table from the given catalog path.
void	packGPValue(IGPValue pValue, Object pInput) Sets the given geoprocessing value into the given parameter/variable.
String	qualifyOutputCatalogPath(String catalogPath) Qualify the catalog path with the GDBs database and user names.
void	qualifyOutputDataElement(IGPValue pValue) Qualify the catalog path of the given value with the GDBs database and user names.
void	refreshCatalog(IDataElement pSourceDataElement) Refreshes the parent within the catalog of the given data element.
void	refreshView() Refreshes the applications active view.
void	releaseInternals() Releases all internal objects used prior to releasing this GPUtilities object.
void	removeFromMap(IGPValue pGPValue, String name) Removes the data/layers specified by the geoprocessing value object and/or name.
void	removeInternalLayer(String name) Removes the internal layer.
void	removeInternalLayerEx(ILayer pLayer) Removes the internal layer.
void	removeInternalTable(String name) Removes the internal table.
void	removeInternalTableEx(ITable pTable) Removes the internal table.
void	removeInternalValues() Removes all of the GPValues returned from MakeGPValueFromObject.
void	rename(IGPValue pSourceGPValue, IGPValue pTargetGPValue) Renames the object referred to by the given geoprocessing value object.
void	setGridIndex(IGPEnvironmentManager pEnvMgr, IArray pInputTables, double spatialIndex1, double spatialIndex2, double spatialIndex3, Object pUnk, IGeometryDef pGeometryDef) Calculates and sets the grid index sizes on the given geometry definition object.
void	setRefreshCatalogParent(boolean pRefresh) Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.
void	setWorkspace(String workPath) Sets the path to the current workspace.
IGPValue	unpackGPValue(Object pInput) Returns the geoprocessing value object from the given parameter, variable, or value object.
boolean	validateExists(IGPValue pGPValue, boolean checkDerived) Verifies that the data referenced by the given geoprocessing value object exists.

Method Detail

internalValidate

IGPMessages internalValidate(IArray pParameters,
                             IArray pParamValues,
                             boolean updateValues,
                             boolean honorDerivedFlag,
                             IGPEnvironmentManager pEnvMgr)
                             throws IOException,
                                    AutomationException

Performs a validation of the parameters to a GPTool.

Remarks

The InternalValidate method is called during Validate, when it performs checks on required data elements to ensure they exist and are valid. In particular, it verifies data types and their values against data definitions, and if the values are members of a defined domain. InternalValidate also checks geoprocessing environment settings.

Product Availability

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

Parameters:

pParameters - A reference to a com.esri.arcgis.system.IArray (in)

pParamValues - A reference to a com.esri.arcgis.system.IArray (in)

updateValues - The updateValues (in)

honorDerivedFlag - The honorDerivedFlag (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (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.

internalValidateValue

void internalValidateValue(IGPParameter pParameter,
                           Object pValue,
                           boolean updateValue,
                           boolean honorDerivedFlag,
                           IGPEnvironmentManager pEnvMgr,
                           IGPMessage pMessage)
                           throws IOException,
                                  AutomationException

Performs a validation of the a single parameter to a GPTool.

Product Availability

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

Parameters:

pParameter - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

pValue - A reference to another Object (IUnknown) (in)

updateValue - The updateValue (in)

honorDerivedFlag - The honorDerivedFlag (in)

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

pMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBadMessage

boolean isBadMessage(IGPMessages pMessages,
                     int index)
                     throws IOException,
                            AutomationException

Tests if a given message within an array of messages is bad.

Product Availability

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

Parameters:

pMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

index - The index (in)

Returns:

The pBadMsg

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateDefaultOutputValue

IGPValue generateDefaultOutputValue(IGPEnvironmentManager pEnvMgr,
                                    String functionname,
                                    IGPParameter pOutputParam,
                                    IGPValue pInputValue,
                                    String extension,
                                    int outputFileBaseLimit)
                                    throws IOException,
                                           AutomationException

Generates the default output value and sets its path to an unique name.

Remarks

The GenerateDefaultOutputValue method is called during validation inside IGPFunction_Validate to return an output path as a value object [IGPValue].

Product Availability

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

Parameters:

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

functionname - The functionname (in)

pOutputParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)

pInputValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

extension - The extension (in)

outputFileBaseLimit - The outputFileBaseLimit (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyOutputDataElement

void qualifyOutputDataElement(IGPValue pValue)
                              throws IOException,
                                     AutomationException

Qualify the catalog path of the given value with the GDBs database and user names.

Product Availability

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

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyOutputCatalogPath

String qualifyOutputCatalogPath(String catalogPath)
                                throws IOException,
                                       AutomationException

Qualify the catalog path with the GDBs database and user names.

Product Availability

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

Parameters:

catalogPath - The catalogPath (in)

Returns:

The pQualifiedCatalogPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnQualifiedCatalogPath

String getUnQualifiedCatalogPath(IGPValue pValue)
                                 throws IOException,
                                        AutomationException

Returns the unqualified path by striping the GDBs database and user names.

Product Availability

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

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspace

void setWorkspace(String workPath)
                  throws IOException,
                         AutomationException

Sets the path to the current workspace.

Product Availability

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

Supported Platforms

Windows

Parameters:

workPath - The workPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspace

String getWorkspace()
                    throws IOException,
                           AutomationException

Sets the path to the current workspace.

Product Availability

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

Supported Platforms

Windows

Returns:

The workPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalog

Object getCatalog()
                  throws IOException,
                         AutomationException

Returns the catalog object shared between geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRefreshCatalogParent

boolean isRefreshCatalogParent()
                               throws IOException,
                                      AutomationException

Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

Returns:

The pRefresh

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRefreshCatalogParent

void setRefreshCatalogParent(boolean pRefresh)
                             throws IOException,
                                    AutomationException

Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

Parameters:

pRefresh - The pRefresh (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElement

IDataElement makeDataElement(String catalogPath,
                             IGPDataType pDataType,
                             IDEBrowseOptions pExpandOptions)
                             throws IOException,
                                    AutomationException

Returns a data element object from the catalog object specified by the given path, data type, and expand options.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

pExpandOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElementFromNameObject

IDataElement makeDataElementFromNameObject(IName name)
                                           throws IOException,
                                                  AutomationException

Creates a new data element object from the given name object.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandDataElement

void expandDataElement(IDataElement pInDE,
                       IDEBrowseOptions pExpandOptions)
                       throws IOException,
                              AutomationException

Expands the properties of the given data element according to the given expand options.

Product Availability

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

Supported Platforms

Windows

Parameters:

pInDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

pExpandOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDataElement

IDataElement createDataElement(String catalogPath,
                               IGPDataType pDataType,
                               String optionalWorkspace)
                               throws IOException,
                                      AutomationException

Creates a new data element object from the catalog object specified by the given path, data type, and optional workspace.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

optionalWorkspace - The optionalWorkspace (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeatureLayer

IGPValue createFeatureLayer(String catalogPath)
                            throws IOException,
                                   AutomationException

Creates a geoprocessing feature layer object from the catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openRasterDatasetFromString

IRasterDataset openRasterDatasetFromString(String catalogPath)
                                           throws IOException,
                                                  AutomationException

Opens a raster dataset object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFeatureClassFromString

IFeatureClass openFeatureClassFromString(String catalogPath)
                                         throws IOException,
                                                AutomationException

Opens a feature class from the given catalog path.

Remarks

The OpenFeatureClassFromString method creates a FeatureClass object by simply taking in the ArcCatalog path of a feature class as a string.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openTableFromString

ITable openTableFromString(String catalogPath)
                           throws IOException,
                                  AutomationException

Opens a table from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openRasterLayerFromString

IRasterLayer openRasterLayerFromString(String catalogPath)
                                       throws IOException,
                                              AutomationException

Opens a raster layer object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.carto.IRasterLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFeatureLayerFromString

IFeatureLayer openFeatureLayerFromString(String catalogPath)
                                         throws IOException,
                                                AutomationException

Opens a feature layer from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.carto.IFeatureLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFeatureClassName

IName createFeatureClassName(String catalogPath)
                             throws IOException,
                                    AutomationException

Creates a feature class name object from the given catalog path.

Remarks

The CreateFeatureClassName method returns a Name object [IName] from the ArcCatalog path string of a feature class.

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRasterDatasetName

IName createRasterDatasetName(String catalogPath)
                              throws IOException,
                                     AutomationException

Creates a raster dataset name object from the given catalog path.

Remarks

The CreateRasterDatasetName method takes in an ArcCatalog path string of a raster dataset and returns a Name object [IName].

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRasterCatalogName

IName createRasterCatalogName(String catalogPath)
                              throws IOException,
                                     AutomationException

Creates a raster catalog name object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTableName

IName createTableName(String catalogPath)
                      throws IOException,
                             AutomationException

Creates a table name object from the given catalog path.

Remarks

The CreateTableName method takes in an ArcCatalog path string of a table and returns a Name object [IName].

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDataset

IDataset openDataset(IGPValue pValue)
                     throws IOException,
                            AutomationException

Opens the dataset object specified by the given geoprocessing value object.

Remarks

The OpenDataset method takes in a GPValue object and returns and opens the specified Dataset object. It is typically used inside the Execute method to open the input data.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDatasetFromLocation

IDataset openDatasetFromLocation(String catalogPath)
                                 throws IOException,
                                        AutomationException

Opens the dataset object from the given catalog path.

Remarks

The OpenDatasetFromLocation method provides a quick way to get a dataset from its location path string. It takes in an ArcCatalog path string and returns a Dataset object [IDataset].

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addToMap

void addToMap(IGPValue pGPValue,
              String name,
              boolean temporary,
              Object pUnkRenderer)
              throws IOException,
                     AutomationException

Adds the given geoprocessing value object to the application display.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

temporary - The temporary (in)

pUnkRenderer - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshCatalog

void refreshCatalog(IDataElement pSourceDataElement)
                    throws IOException,
                           AutomationException

Refreshes the parent within the catalog of the given data element.

Remarks

The RefreshCatalog method forces a refresh of the catalog tree after executuion of a geoprocessing operation such as a create or delete.

Refer to the code sample to see how this method can be used.

Product Availability

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

Supported Platforms

Windows

Parameters:

pSourceDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportFeatureClass

void exportFeatureClass(IDataElement pSourceDataElement,
                        IDataElement pTargetDataElement)
                        throws IOException,
                               AutomationException

Exports the given feature class to a new feature class.

Product Availability

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

Supported Platforms

Windows

Parameters:

pSourceDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

pTargetDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(IGPValue pGPValue)
            throws IOException,
                   AutomationException

Deletes the object referred to by the given geoprocessing value object.

Remarks

The Delete method is typically used in combination with the Exists method to first check existence of a value such as in the case of checking if the OverwriteOutput setting is true or false. A code sample is included below. For an extended code sample refer to the Execute Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

rename

void rename(IGPValue pSourceGPValue,
            IGPValue pTargetGPValue)
            throws IOException,
                   AutomationException

Renames the object referred to by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pSourceGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pTargetGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

void copy(IGPValue pSourceGPValue,
          IGPValue pTargetGPValue)
          throws IOException,
                 AutomationException

Copies the object referred to by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pSourceGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pTargetGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exists

boolean exists(IGPValue pGPValue)
               throws IOException,
                      AutomationException

Returns whether the object referred to by the given geoprocessing value object exists.

Remarks

The Exists method checks if a value exists, or has been created. A code sample is included below. For an extended code sample refer to the Execute Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

The exists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compareWildCard

boolean compareWildCard(String wildCard,
                        String data)
                        throws IOException,
                               AutomationException

Returns whether the given string satisfies the given wildcard string.

Product Availability

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

Supported Platforms

Windows

Parameters:

wildCard - The wildCard (in)

data - The data (in)

Returns:

The matched

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameObject

IName getNameObject(IDataElement pDataElement)
                    throws IOException,
                           AutomationException

Returns a name object corresponding to the object referred to by the given data element.

Product Availability

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

Supported Platforms

Windows

Parameters:

pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameObjectFromLocation

IName getNameObjectFromLocation(String locationMoniker)
                                throws IOException,
                                       AutomationException

Returns a name object corresponding to the object by the location moniker.

Product Availability

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

Supported Platforms

Windows

Parameters:

locationMoniker - The locationMoniker (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObjectFromLocation

Object getGxObjectFromLocation(String catalogPath)
                               throws IOException,
                                      AutomationException

Returns the catalog object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fieldExists

boolean fieldExists(IGPValue pGPValue,
                    IField pField)
                    throws IOException,
                           AutomationException

Returns whether the given field exists within the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pField - A reference to a com.esri.arcgis.geodatabase.IField (in)

Returns:

The pExists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findField

IField findField(IGPValue pGPValue,
                 String name)
                 throws IOException,
                        AutomationException

Returns the field object with the specified name in the given geoprocessing value object.

Remarks

The FindField method returns the field object of the specified name in the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapLayers

IEnumLayer getMapLayers()
                        throws IOException,
                               AutomationException

Returns an enumeration of the current layers in the application.

Product Availability

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

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.carto.IEnumLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMapLayer

ILayer findMapLayer(String name)
                    throws IOException,
                           AutomationException

Returns a layer with the given name.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMapLayer2

IGPLayer findMapLayer2(String name,
                       ILayer[] ppLayer)
                       throws IOException,
                              AutomationException

Returns a layer and geoprocessing layer with the given name.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (out: use single element array)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.IGPLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGPLayers

IEnumGPValue getGPLayers()
                         throws IOException,
                                AutomationException

Returns an enumeration of current geoprocessing layers.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeGPLayer

IGPLayer makeGPLayer(String catalogPath,
                     IGPDataType pDataType)
                     throws IOException,
                            AutomationException

Creates a geoprocessing layer object from the given catalog path and of the given geoprocessing data type.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.IGPLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEnvironment

IGPEnvironment getEnvironment(IArray pEnvironments,
                              String name)
                              throws IOException,
                                     AutomationException

Locates a geoprocessing environment with the given name in the given array.

Remarks

The GetEnvironment property provides access to any geoprocessing environments for an application or session.

Refer to the code sample to see how to use this property.

Product Availability

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

Supported Platforms

Windows

Parameters:

pEnvironments - A reference to a com.esri.arcgis.system.IArray (in)

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInternalLayer

void addInternalLayer(ILayer pLayer)
                      throws IOException,
                             AutomationException

Adds a layer object to the geoprocessing utility object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInternalLayer2

void addInternalLayer2(ILayer pLayer,
                       IGPLayer pGPLayer)
                       throws IOException,
                              AutomationException

Adds a layer object and geoprocessing layer object to the geoprocessing utility object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

pGPLayer - A reference to a com.esri.arcgis.datasourcesfile.IGPLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeGPLayerFromLayer

IGPLayer makeGPLayerFromLayer(ILayer pLayer)
                              throws IOException,
                                     AutomationException

Creates a geoprocessing layer object based on the given layer object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.IGPLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createParentFromCatalogPath

IName createParentFromCatalogPath(String catalogPath)
                                  throws IOException,
                                         AutomationException

Returns a name object corresponding to the parent object of the specified catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unpackGPValue

IGPValue unpackGPValue(Object pInput)
                       throws IOException,
                              AutomationException

Returns the geoprocessing value object from the given parameter, variable, or value object.

Remarks

The UnpackGPValue method is used to access the value from a specific function parameter. A code sample is included below. For an extended code sample refer to the Validate Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Parameters:

pInput - A reference to another Object (IUnknown) (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeRasterLayer

void decodeRasterLayer(IGPValue pValue,
                       IRasterDataset[] ppRD)
                       throws IOException,
                              AutomationException

Returns the raster dataset specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

ppRD - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeFeatureLayer

void decodeFeatureLayer(IGPValue pValue,
                        IFeatureClass[] ppFC,
                        IQueryFilter[] ppQF)
                        throws IOException,
                               AutomationException

Returns the feature class and query filter specified by the given geoprocessing value object.

Remarks

The DecodeFeatureLayer method is a wrapper function that quickly and easily creates a value from an object. It is called inside IGPFuncion_Validate .

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

ppFC - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (out: use single element array)

ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeTableView

void decodeTableView(IGPValue pValue,
                     ITable[] ppTable,
                     IQueryFilter[] ppQF)
                     throws IOException,
                            AutomationException

Returns the table and query filter specified by the given geoprocessing value object.

Remarks

The DecodeTableView method is a wrapper function that quickly and easily creates a value from an object. Like the DecodeFeatureLayer, it is called inside IGPFuncion_Validate .

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (out: use single element array)

ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeLayer

ILayer decodeLayer(IGPValue pValue)
                   throws IOException,
                          AutomationException

Returns the layer object specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeStandaloneTable

IStandaloneTable decodeStandaloneTable(IGPValue pValue)
                                       throws IOException,
                                              AutomationException

Returns the standalone table object specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

A reference to a com.esri.arcgis.carto.IStandaloneTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeDETable

IDETable decodeDETable(IGPValue pValue)
                       throws IOException,
                              AutomationException

Returns the table data element specified by the given geoprocessing value object.

Remarks

The DecodeDETable method is a wrapper function to quickly create a value from an object. It returns the table data element specified by the given geoprocessing value object. For a code sample see below.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

releaseInternals

void releaseInternals()
                      throws IOException,
                             AutomationException

Releases all internal objects used prior to releasing this GPUtilities object.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapTables

IEnumTable getMapTables()
                        throws IOException,
                               AutomationException

Returns an enumeration of standalone tables in the current map.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMapTable

ITable findMapTable(String name)
                    throws IOException,
                           AutomationException

Locates a table with the specified name.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findMapTable2

IGPTableView findMapTable2(String name,
                           ITable[] ppTable)
                           throws IOException,
                                  AutomationException

Locates a table with the specified name and returns the table and geoprocessing table view objects.

Product Availability

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

Supported Platforms

Windows

Parameters:

name - The name (in)

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (out: use single element array)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGPTableViews

IEnumGPValue getGPTableViews()
                             throws IOException,
                                    AutomationException

Returns an enumeration of geoprocessing table views.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGPTableView

boolean isGPTableView(IGPValue pValue)
                      throws IOException,
                             AutomationException

Returns test if a geoprocessing table views is in fact a table and not from a layer.

Product Availability

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

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeGPTableView

IGPTableView makeGPTableView(String catalogPath,
                             IGPDataType pDataType)
                             throws IOException,
                                    AutomationException

Returns a geoprocessing table view object corresponding to the given catalog path and of the specified geoprocessing data type.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInternalTable

void addInternalTable(ITable pTable)
                      throws IOException,
                             AutomationException

Adds the given table to the utility object's list of tables.

Product Availability

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

Supported Platforms

Windows

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInternalTable2

void addInternalTable2(ITable pTable,
                       IGPTableView pGPTableView)
                       throws IOException,
                              AutomationException

Adds the given table to the utility object's list of tables.

Product Availability

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

Supported Platforms

Windows

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

pGPTableView - A reference to a com.esri.arcgis.geoprocessing.IGPTableView (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeGPTableViewFromTable

IGPTableView makeGPTableViewFromTable(ITable pTable)
                                      throws IOException,
                                             AutomationException

Returns a new geoprocessing table view object from the given table object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields(IGPValue pValue)
                  throws IOException,
                         AutomationException

Returns a collection of field objects contained in the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canAddToMap

boolean canAddToMap()
                    throws IOException,
                           AutomationException

Returns whether datasets can be added to the current application display.

Product Availability

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

Supported Platforms

Windows

Returns:

The pCanAddToMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateSpRef

void generateSpRef(IArray pInputTables,
                   ITable pOverlayTable,
                   double growExtentBy,
                   ISpatialReference[] ppSpRef,
                   IEnvelope[] ppExtent,
                   boolean[] pHasMs,
                   double[] pMMin,
                   double[] pMMax,
                   boolean[] pHasZs,
                   double[] pZMin,
                   double[] pZMax)
                   throws IOException,
                          AutomationException

Generates a new spatial reference object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pInputTables - A reference to a com.esri.arcgis.system.IArray (in)

pOverlayTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

growExtentBy - The growExtentBy (in)

ppSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (out: use single element array)

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)

pHasMs - The pHasMs (out: use single element array)

pMMin - The pMMin (out: use single element array)

pMMax - The pMMax (out: use single element array)

pHasZs - The pHasZs (out: use single element array)

pZMin - The pZMin (out: use single element array)

pZMax - The pZMax (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGridIndex

void setGridIndex(IGPEnvironmentManager pEnvMgr,
                  IArray pInputTables,
                  double spatialIndex1,
                  double spatialIndex2,
                  double spatialIndex3,
                  Object pUnk,
                  IGeometryDef pGeometryDef)
                  throws IOException,
                         AutomationException

Calculates and sets the grid index sizes on the given geometry definition object.

Product Availability

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

Supported Platforms

Windows

Parameters:

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

pInputTables - A reference to a com.esri.arcgis.system.IArray (in)

spatialIndex1 - The spatialIndex1 (in)

spatialIndex2 - The spatialIndex2 (in)

spatialIndex3 - The spatialIndex3 (in)

pUnk - A reference to another Object (IUnknown) (in)

pGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetType

boolean isDatasetType(Object pUnknown)
                      throws IOException,
                             AutomationException

Returns whether the given object is a dataset.

Product Availability

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

Supported Platforms

Windows

Parameters:

pUnknown - A reference to another Object (IUnknown) (in)

Returns:

The pIsDataset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeFromMap

void removeFromMap(IGPValue pGPValue,
                   String name)
                   throws IOException,
                          AutomationException

Removes the data/layers specified by the geoprocessing value object and/or name.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDerived

boolean isDerived(Object pInput)
                  throws IOException,
                         AutomationException

Returns whether the given variable or parameter is derived.

Product Availability

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

Supported Platforms

Windows

Parameters:

pInput - A reference to another Object (IUnknown) (in)

Returns:

The pDerived

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshView

void refreshView()
                 throws IOException,
                        AutomationException

Refreshes the applications active view.

Product Availability

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

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

packGPValue

void packGPValue(IGPValue pValue,
                 Object pInput)
                 throws IOException,
                        AutomationException

Sets the given geoprocessing value into the given parameter/variable.

Remarks

The PackGPValue method is used to assign, for example an output value to a specific function parameter. such as a derived output. A code sample is included below. For an extended code sample refer to the Validate Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pInput - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createParameterValue

IGPValue createParameterValue(String text,
                              IGPDataType pDataType,
                              int direction)
                              throws IOException,
                                     AutomationException

Creates a geoprocessing value object of the given data type from the given string.

Product Availability

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

Supported Platforms

Windows

Parameters:

text - The text (in)

pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)

direction - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validateExists

boolean validateExists(IGPValue pGPValue,
                       boolean checkDerived)
                       throws IOException,
                              AutomationException

Verifies that the data referenced by the given geoprocessing value object exists.

Product Availability

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

Supported Platforms

Windows

Parameters:

pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

checkDerived - The checkDerived (in)

Returns:

The exists

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObject

Object getGxObject(IDataElement pDataElement)
                   throws IOException,
                          AutomationException

Returns the catalog object corresponding to the given data element.

Product Availability

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

Supported Platforms

Windows

Parameters:

pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObjects

IArray getGxObjects(String catalogPath)
                    throws IOException,
                           AutomationException

Returns an array of all catalog objects which correspond to the catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeDataElements

IArray makeDataElements(String catalogPath,
                        IDEBrowseOptions pBrowseOptions)
                        throws IOException,
                               AutomationException

Get data elements from catalog path.

Product Availability

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

Supported Platforms

Windows

Parameters:

catalogPath - The catalogPath (in)

pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGPMapData

IEnumGPValue getGPMapData()
                          throws IOException,
                                 AutomationException

Returns an enumeration of geoprocessing data.

Product Availability

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

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeGPValueFromObject

IGPValue makeGPValueFromObject(Object pUnk)
                               throws IOException,
                                      AutomationException

Generate an GPValue from an Arc Object.

Product Availability

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

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInternalValues

void removeInternalValues()
                          throws IOException,
                                 AutomationException

Removes all of the GPValues returned from MakeGPValueFromObject.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInternalLayer

void removeInternalLayer(String name)
                         throws IOException,
                                AutomationException

Removes the internal layer.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInternalTable

void removeInternalTable(String name)
                         throws IOException,
                                AutomationException

Removes the internal table.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

decodeRaster

IRaster decodeRaster(IGPValue pValue)
                     throws IOException,
                            AutomationException

Returns the raster specified by the given geoprocessing value object.

Product Availability

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

Parameters:

pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGPSpRefEnv

ISpatialReference getGPSpRefEnv(IGPEnvironmentManager pEnvMgr,
                                ISpatialReference pSrcSpRef,
                                IEnvelope pNewExtent,
                                double newMMin,
                                double newMMax,
                                double newZMin,
                                double newZMax,
                                Object pWkspFDS)
                                throws IOException,
                                       AutomationException

Creates the spatial reference from both a source and environment.

Remarks

The GetGPSpRefEnv method takes in a pEnvMgr and a pSrcSpRef object and returns a SpatialReference object.

Product Availability

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

Parameters:

pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)

pSrcSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

pNewExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

newMMin - The newMMin (in)

newMMax - The newMMax (in)

newZMin - The newZMin (in)

newZMax - The newZMax (in)

pWkspFDS - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInternalLayerEx

void removeInternalLayerEx(ILayer pLayer)
                           throws IOException,
                                  AutomationException

Removes the internal layer.

Product Availability

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

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeInternalTableEx

void removeInternalTableEx(ITable pTable)
                           throws IOException,
                                  AutomationException

Removes the internal table.

Product Availability

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

Parameters:

pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.