com.esri.arcgis.geoprocessing
Interface IGpDispatch

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGpDispatchProxy

public interface IGpDispatch
extends Serializable

Provides access to the properties and methods of a Geoprocessor object.

When To Use

The GPDispatch object is a coarse grainded ArcObject that permits geoprocessing tools and environments to be used in a scripting language. This object supports the COM IDispatch object. This object may also be used in COM-compliant languages such as Visual Basic for Applications (VBA), and Visual Basic. With ArcGIS 9.2, you are now recommended to use the new Geoprocessor class.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addError(String message)
          Sets the output error message.
 void addMessage(String message)
          Sets the output message.
 void addReturnMessage(int index)
          Sets the return message as an output message by index.
 void addToolbox(String toolbox)
          Add the toolbox to the current session.
 void addWarning(String message)
          Sets the output warning message.
 String checkExtension(String extension)
          Checks the status of a product extension.
 String checkInExtension(String extension)
          Checks in a product extension.
 String checkOutExtension(String extension)
          Checks out a product extension.
 String checkProduct(String code)
          Check the status of a license code.
 void clearEnvironment(String env)
          Clears the value of a given environment.
 String command(String commandLine)
          executes the given command line.
 void copyParameter(int from, int to)
          Copy given tool parameter to another.
 Object createObject(Object pObjectName, Object pExtraArg)
          Creates a geoprocessing object that can be used in a scripting environment.
 Object createRandomValueGenerator(int seed, String distributionType)
          Creates a geoprocessing random number generator object that can be used to generate random numbers.
 String createScratchName(Object prefix, Object suffix, Object dataType, Object workspace)
          Creates a scratch name for the given workspace.
 String createUniqueName(String inputTableName, Object workspace)
          Creates a unique name for the given workspace.
 Object describe(Object pInputValue, Object dataType)
          Returns a descriptor object describing the properties of the specified data element.
 boolean exists(Object pInputValue, Object dataType)
          Checks if a data element exists.
 int getMaxSeverity()
          The maximum severity of the return messages.
 String getMessage(int index)
          Gets the return message by index.
 int getMessageCount()
          The number of returned messages.
 String getMessages(Object severity)
          Gets all the return messages.
 String getParameterAsText(int index)
          Gets given tool parameter as text.
 int getParameterCount()
          The number of input tool parameters.
 int getReturnCode(int index)
          Gets the return code by index.
 int getSeverity(int index)
          Gets the return severity by index.
 String getSystemEnvironment(String envName)
          Gets the given system environment.
 String getToolbox()
          Sets the current (default) toolbox.
 Object insertCursor(Object pInputValue, Object spRef)
          Returns an insert cursor object against the given table/feature class.
 boolean isLogHistory()
          Indicates whether or not operations are logged or not.
 boolean isOverwriteOutput()
          Indicates whether or not outputs should be overwritten.
 Object listDatasets(Object wildCard, Object featureType)
          Returns a collection of datasets in the current workspace based on a query string and type.
 Object listEnvironments(Object pWildcard)
          Gets list of GeoProcessor Environments.
 Object listFeatureClasses(Object wildCard, Object featureType, Object dataset)
          Returns a collection of feature classes in the current workspace or optional dataset, based on a query string and type.
 Object listFields(Object pInputValue, Object wildCard, Object fieldType)
          Returns a collection of fields in the given table/feature class based on a query string and type.
 Object listIndexes(Object pInputValue, Object wildCard)
          Returns a collection of indexes in the given table/feature class based on a query string and type.
 Object listRasters(Object wildCard, Object rasterType)
          Returns a collection of rasters in the current workspace based on a query string and type.
 Object listTables(Object wildCard, Object tableType)
          Returns a collection of tables in the current workspace based on a query string and type.
 Object listToolboxes(Object pWildcard)
          Gets list of GeoProcessor Toolboxes.
 Object listTools(Object pWildcard)
          Gets list of GeoProcessor Tools.
 Object listWorkspaces(Object wildCard, Object workspaceType)
          Returns a collection of workspaces in the current workspace based on a query string and type.
 void loadSettings(String fileName)
          Loads the current GeoProcessor environment settings.
 String parseFieldName(String inputFieldName, Object workspace)
          Parses a field name into its constituent parts.
 String parseTableName(String inputTableName, Object workspace)
          Parses a table name into its constituent parts.
 String productInfo()
          Gets the product license info.
 String qualifyFieldName(String inputFieldName, Object workspace)
          Qualifies a field name for the workspace and connected user.
 String qualifyTableName(String inputTableName, Object workspace)
          Qualifies a table name for the workspace and connected user.
 void refreshCatalog(Object pInputValue)
          Refreshes the parent of the specified object in the catalog object associated with the Geoprocessor.
 void removeToolbox(String toolbox)
          Remove the toolbox from the current session.
 void resetEnvironments()
          Tests if a given environments value is set or not.
 void saveSettings(String fileName)
          Saves the current GeoProcessor environment settings.
 Object searchCursor(Object pInputValue, Object whereClause, Object spRef, Object fields, Object sortFields)
          Returns a search cursor object against the given table/feature class.
 void setLogHistory(boolean logHistory)
          Indicates whether or not operations are logged or not.
 void setOverwriteOutput(boolean overwriteOutput)
          Indicates whether or not outputs should be overwritten.
 void setParameterAsText(int index, String argument)
          Sets given tool parameter as text.
 String setProduct(String code)
          Sets the license level.
 void setToolbox(String toolbox)
          Sets the current (default) toolbox.
 String testSchemaLock(String fileName)
          Tests if an exclusive schema lock is set on a dataset.
 Object updateCursor(Object pInputValue, Object whereClause, Object spRef, Object fields, Object sortFields)
          Returns an update cursor object against the given table/feature class.
 String usage(String method)
          Generates the Usage for a given tool.
 String validateFieldName(String inputFieldName, Object workspace)
          Checks a field for compatibility with the workspace.
 String validateTableName(String inputTableName, Object workspace)
          Checks a table name for compatibility with the workspace.
 

Method Detail

getMessageCount

int getMessageCount()
                    throws IOException,
                           AutomationException
The number of returned messages.

Product Availability

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

Supported Platforms

Windows

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

String getMessage(int index)
                  throws IOException,
                         AutomationException
Gets the return message by index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The message
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeverity

int getSeverity(int index)
                throws IOException,
                       AutomationException
Gets the return severity by index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The severity
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReturnCode

int getReturnCode(int index)
                  throws IOException,
                         AutomationException
Gets the return code by index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The code
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessages

String getMessages(Object severity)
                   throws IOException,
                          AutomationException
Gets all the return messages.

Product Availability

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

Supported Platforms

Windows

Parameters:
severity - A Variant (in, optional, pass null if not required)
Returns:
The messages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxSeverity

int getMaxSeverity()
                   throws IOException,
                          AutomationException
The maximum severity of the return messages.

Product Availability

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

Supported Platforms

Windows

Returns:
The severity
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage

void addMessage(String message)
                throws IOException,
                       AutomationException
Sets the output message.

Product Availability

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

Supported Platforms

Windows

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addError

void addError(String message)
              throws IOException,
                     AutomationException
Sets the output error message.

Product Availability

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

Supported Platforms

Windows

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addWarning

void addWarning(String message)
                throws IOException,
                       AutomationException
Sets the output warning message.

Product Availability

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

Supported Platforms

Windows

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addReturnMessage

void addReturnMessage(int index)
                      throws IOException,
                             AutomationException
Sets the return message as an output message by index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProduct

String setProduct(String code)
                  throws IOException,
                         AutomationException
Sets the license level.

Product Availability

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

Supported Platforms

Windows

Parameters:
code - The code (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkProduct

String checkProduct(String code)
                    throws IOException,
                           AutomationException
Check the status of a license code.

Product Availability

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

Supported Platforms

Windows

Parameters:
code - The code (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

productInfo

String productInfo()
                   throws IOException,
                          AutomationException
Gets the product license info.

Product Availability

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

Supported Platforms

Windows

Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkOutExtension

String checkOutExtension(String extension)
                         throws IOException,
                                AutomationException
Checks out a product extension.

Product Availability

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

Supported Platforms

Windows

Parameters:
extension - The extension (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkInExtension

String checkInExtension(String extension)
                        throws IOException,
                               AutomationException
Checks in a product extension.

Product Availability

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

Supported Platforms

Windows

Parameters:
extension - The extension (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkExtension

String checkExtension(String extension)
                      throws IOException,
                             AutomationException
Checks the status of a product extension.

Product Availability

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

Supported Platforms

Windows

Parameters:
extension - The extension (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameterCount

int getParameterCount()
                      throws IOException,
                             AutomationException
The number of input tool parameters.

Product Availability

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

Supported Platforms

Windows

Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameterAsText

String getParameterAsText(int index)
                          throws IOException,
                                 AutomationException
Gets given tool parameter as text.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
The argument
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setParameterAsText

void setParameterAsText(int index,
                        String argument)
                        throws IOException,
                               AutomationException
Sets given tool parameter as text.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
argument - The argument (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copyParameter

void copyParameter(int from,
                   int to)
                   throws IOException,
                          AutomationException
Copy given tool parameter to another.

Product Availability

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

Supported Platforms

Windows

Parameters:
from - The from (in)
to - The to (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listTools

Object listTools(Object pWildcard)
                 throws IOException,
                        AutomationException
Gets list of GeoProcessor Tools.

Product Availability

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

Supported Platforms

Windows

Parameters:
pWildcard - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listEnvironments

Object listEnvironments(Object pWildcard)
                        throws IOException,
                               AutomationException
Gets list of GeoProcessor Environments.

Product Availability

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

Supported Platforms

Windows

Parameters:
pWildcard - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listToolboxes

Object listToolboxes(Object pWildcard)
                     throws IOException,
                            AutomationException
Gets list of GeoProcessor Toolboxes.

Product Availability

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

Supported Platforms

Windows

Parameters:
pWildcard - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToolbox

void setToolbox(String toolbox)
                throws IOException,
                       AutomationException
Sets the current (default) toolbox.

Product Availability

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

Supported Platforms

Windows

Parameters:
toolbox - The toolbox (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToolbox

String getToolbox()
                  throws IOException,
                         AutomationException
Sets the current (default) toolbox.

Product Availability

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

Supported Platforms

Windows

Returns:
The toolbox
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addToolbox

void addToolbox(String toolbox)
                throws IOException,
                       AutomationException
Add the toolbox to the current session.

Product Availability

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

Supported Platforms

Windows

Parameters:
toolbox - The toolbox (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeToolbox

void removeToolbox(String toolbox)
                   throws IOException,
                          AutomationException
Remove the toolbox from the current session.

Product Availability

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

Supported Platforms

Windows

Parameters:
toolbox - The toolbox (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSystemEnvironment

String getSystemEnvironment(String envName)
                            throws IOException,
                                   AutomationException
Gets the given system environment.

Product Availability

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

Supported Platforms

Windows

Parameters:
envName - The envName (in)
Returns:
The pEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

command

String command(String commandLine)
               throws IOException,
                      AutomationException
executes the given command line.

Product Availability

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

Supported Platforms

Windows

Parameters:
commandLine - The commandLine (in)
Returns:
The results
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

usage

String usage(String method)
             throws IOException,
                    AutomationException
Generates the Usage for a given tool.

Product Availability

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

Supported Platforms

Windows

Parameters:
method - The method (in)
Returns:
The usage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exists

boolean exists(Object pInputValue,
               Object dataType)
               throws IOException,
                      AutomationException
Checks if a data element exists.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
dataType - A Variant (in, optional, pass null if not required)
Returns:
The exists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshCatalog

void refreshCatalog(Object pInputValue)
                    throws IOException,
                           AutomationException
Refreshes the parent of the specified object in the catalog object associated with the Geoprocessor.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listFeatureClasses

Object listFeatureClasses(Object wildCard,
                          Object featureType,
                          Object dataset)
                          throws IOException,
                                 AutomationException
Returns a collection of feature classes in the current workspace or optional dataset, based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
wildCard - A Variant (in, optional, pass null if not required)
featureType - A Variant (in, optional, pass null if not required)
dataset - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listDatasets

Object listDatasets(Object wildCard,
                    Object featureType)
                    throws IOException,
                           AutomationException
Returns a collection of datasets in the current workspace based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
wildCard - A Variant (in, optional, pass null if not required)
featureType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listTables

Object listTables(Object wildCard,
                  Object tableType)
                  throws IOException,
                         AutomationException
Returns a collection of tables in the current workspace based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
wildCard - A Variant (in, optional, pass null if not required)
tableType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listRasters

Object listRasters(Object wildCard,
                   Object rasterType)
                   throws IOException,
                          AutomationException
Returns a collection of rasters in the current workspace based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
wildCard - A Variant (in, optional, pass null if not required)
rasterType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listWorkspaces

Object listWorkspaces(Object wildCard,
                      Object workspaceType)
                      throws IOException,
                             AutomationException
Returns a collection of workspaces in the current workspace based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
wildCard - A Variant (in, optional, pass null if not required)
workspaceType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listFields

Object listFields(Object pInputValue,
                  Object wildCard,
                  Object fieldType)
                  throws IOException,
                         AutomationException
Returns a collection of fields in the given table/feature class based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
wildCard - A Variant (in, optional, pass null if not required)
fieldType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

listIndexes

Object listIndexes(Object pInputValue,
                   Object wildCard)
                   throws IOException,
                          AutomationException
Returns a collection of indexes in the given table/feature class based on a query string and type.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
wildCard - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchCursor

Object searchCursor(Object pInputValue,
                    Object whereClause,
                    Object spRef,
                    Object fields,
                    Object sortFields)
                    throws IOException,
                           AutomationException
Returns a search cursor object against the given table/feature class.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
whereClause - A Variant (in, optional, pass null if not required)
spRef - A Variant (in, optional, pass null if not required)
fields - A Variant (in, optional, pass null if not required)
sortFields - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateCursor

Object updateCursor(Object pInputValue,
                    Object whereClause,
                    Object spRef,
                    Object fields,
                    Object sortFields)
                    throws IOException,
                           AutomationException
Returns an update cursor object against the given table/feature class.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
whereClause - A Variant (in, optional, pass null if not required)
spRef - A Variant (in, optional, pass null if not required)
fields - A Variant (in, optional, pass null if not required)
sortFields - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertCursor

Object insertCursor(Object pInputValue,
                    Object spRef)
                    throws IOException,
                           AutomationException
Returns an insert cursor object against the given table/feature class.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
spRef - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

describe

Object describe(Object pInputValue,
                Object dataType)
                throws IOException,
                       AutomationException
Returns a descriptor object describing the properties of the specified data element.

Product Availability

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

Supported Platforms

Windows

Parameters:
pInputValue - A Variant (in)
dataType - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createObject

Object createObject(Object pObjectName,
                    Object pExtraArg)
                    throws IOException,
                           AutomationException
Creates a geoprocessing object that can be used in a scripting environment.

Product Availability

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

Supported Platforms

Windows

Parameters:
pObjectName - A Variant (in)
pExtraArg - A Variant (in, optional, pass null if not required)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRandomValueGenerator

Object createRandomValueGenerator(int seed,
                                  String distributionType)
                                  throws IOException,
                                         AutomationException
Creates a geoprocessing random number generator object that can be used to generate random numbers.

Product Availability

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

Parameters:
seed - The seed (in)
distributionType - The distributionType (in)
Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteOutput

void setOverwriteOutput(boolean overwriteOutput)
                        throws IOException,
                               AutomationException
Indicates whether or not outputs should be overwritten.

Product Availability

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

Supported Platforms

Windows

Parameters:
overwriteOutput - The overwriteOutput (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteOutput

boolean isOverwriteOutput()
                          throws IOException,
                                 AutomationException
Indicates whether or not outputs should be overwritten.

Product Availability

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

Supported Platforms

Windows

Returns:
The overwriteOutput
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLogHistory

void setLogHistory(boolean logHistory)
                   throws IOException,
                          AutomationException
Indicates whether or not operations are logged or not.

Product Availability

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

Parameters:
logHistory - The logHistory (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLogHistory

boolean isLogHistory()
                     throws IOException,
                            AutomationException
Indicates whether or not operations are logged or not.

Product Availability

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

Returns:
The logHistory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateFieldName

String validateFieldName(String inputFieldName,
                         Object workspace)
                         throws IOException,
                                AutomationException
Checks a field for compatibility with the workspace.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputFieldName - The inputFieldName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateTableName

String validateTableName(String inputTableName,
                         Object workspace)
                         throws IOException,
                                AutomationException
Checks a table name for compatibility with the workspace.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputTableName - The inputTableName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyFieldName

String qualifyFieldName(String inputFieldName,
                        Object workspace)
                        throws IOException,
                               AutomationException
Qualifies a field name for the workspace and connected user.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputFieldName - The inputFieldName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputFieldName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyTableName

String qualifyTableName(String inputTableName,
                        Object workspace)
                        throws IOException,
                               AutomationException
Qualifies a table name for the workspace and connected user.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputTableName - The inputTableName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseFieldName

String parseFieldName(String inputFieldName,
                      Object workspace)
                      throws IOException,
                             AutomationException
Parses a field name into its constituent parts.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputFieldName - The inputFieldName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputParsedName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseTableName

String parseTableName(String inputTableName,
                      Object workspace)
                      throws IOException,
                             AutomationException
Parses a table name into its constituent parts.

Product Availability

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

Supported Platforms

Windows

Parameters:
inputTableName - The inputTableName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputParsedName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createScratchName

String createScratchName(Object prefix,
                         Object suffix,
                         Object dataType,
                         Object workspace)
                         throws IOException,
                                AutomationException
Creates a scratch name for the given workspace.

Product Availability

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

Parameters:
prefix - A Variant (in, optional, pass null if not required)
suffix - A Variant (in, optional, pass null if not required)
dataType - A Variant (in, optional, pass null if not required)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createUniqueName

String createUniqueName(String inputTableName,
                        Object workspace)
                        throws IOException,
                               AutomationException
Creates a unique name for the given workspace.

Product Availability

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

Parameters:
inputTableName - The inputTableName (in)
workspace - A Variant (in, optional, pass null if not required)
Returns:
The outputTableName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveSettings

void saveSettings(String fileName)
                  throws IOException,
                         AutomationException
Saves the current GeoProcessor environment settings.

Product Availability

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

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadSettings

void loadSettings(String fileName)
                  throws IOException,
                         AutomationException
Loads the current GeoProcessor environment settings.

Product Availability

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

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

testSchemaLock

String testSchemaLock(String fileName)
                      throws IOException,
                             AutomationException
Tests if an exclusive schema lock is set on a dataset.

Product Availability

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

Parameters:
fileName - The fileName (in)
Returns:
The status
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearEnvironment

void clearEnvironment(String env)
                      throws IOException,
                             AutomationException
Clears the value of a given environment.

Product Availability

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

Parameters:
env - The env (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetEnvironments

void resetEnvironments()
                       throws IOException,
                              AutomationException
Tests if a given environments value is set or not.

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.