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


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

IGpDispatch Interface

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

Product Availability

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

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. 

Members

Name Description
Method AddError Sets the output error message.
Method AddMessage Sets the output message.
Method AddReturnMessage Sets the return message as an output message by index.
Method AddToolbox Add the toolbox to the current session.
Method AddWarning Sets the output warning message.
Method CheckExtension Checks the status of a product extension.
Method CheckInExtension Checks in a product extension.
Method CheckOutExtension Checks out a product extension.
Method CheckProduct Check the status of a license code.
Method ClearEnvironment Clears the value of a given environment.
Method Command executes the given command line.
Method CopyParameter Copy given tool parameter to another.
Method CreateObject Creates a geoprocessing object that can be used in a scripting environment.
Method CreateRandomValueGenerator Creates a geoprocessing random number generator object that can be used to generate random numbers.
Method CreateScratchName Creates a scratch name for the given workspace.
Method CreateUniqueName Creates a unique name for the given workspace.
Method Describe Returns a descriptor object describing the properties of the specified data element.
Method Exists Checks if a data element exists.
Method GetMessage Gets the return message by index.
Method GetMessages Gets all the return messages.
Method GetParameterAsText Gets given tool parameter as text.
Method GetReturnCode Gets the return code by index.
Method GetSeverity Gets the return severity by index.
Method GetSystemEnvironment Gets the given system environment.
Method InsertCursor Returns an insert cursor object against the given table/feature class.
Method ListDatasets Returns a collection of datasets in the current workspace based on a query string and type.
Method ListEnvironments Gets list of GeoProcessor Environments.
Method ListFeatureClasses Returns a collection of feature classes in the current workspace or optional dataset, based on a query string and type.
Method ListFields Returns a collection of fields in the given table/feature class based on a query string and type.
Method ListIndexes Returns a collection of indexes in the given table/feature class based on a query string and type.
Method ListRasters Returns a collection of rasters in the current workspace based on a query string and type.
Method ListTables Returns a collection of tables in the current workspace based on a query string and type.
Method ListToolboxes Gets list of GeoProcessor Toolboxes.
Method ListTools Gets list of GeoProcessor Tools.
Method ListWorkspaces Returns a collection of workspaces in the current workspace based on a query string and type.
Method LoadSettings Loads the current GeoProcessor environment settings.
Read/write property LogHistory Indicates whether or not operations are logged or not.
Read-only property MaxSeverity The maximum severity of the return messages.
Read-only property MessageCount The number of returned messages.
Read/write property OverwriteOutput Indicates whether or not outputs should be overwritten.
Read-only property ParameterCount The number of input tool parameters.
Method ParseFieldName Parses a field name into its constituent parts.
Method ParseTableName Parses a table name into its constituent parts.
Method ProductInfo Gets the product license info.
Method QualifyFieldName Qualifies a field name for the workspace and connected user.
Method QualifyTableName Qualifies a table name for the workspace and connected user.
Method RefreshCatalog Refreshes the parent of the specified object in the catalog object associated with the Geoprocessor.
Method RemoveToolbox Remove the toolbox from the current session.
Method ResetEnvironments Tests if a given environments value is set or not.
Method SaveSettings Saves the current GeoProcessor environment settings.
Method SearchCursor Returns a search cursor object against the given table/feature class.
Method SetParameterAsText Sets given tool parameter as text.
Method SetProduct Sets the license level.
Method TestSchemaLock Tests if an exclusive schema lock is set on a dataset.
Read/write property Toolbox Sets the current (default) toolbox.
Method UpdateCursor Returns an update cursor object against the given table/feature class.
Method Usage Generates the Usage for a given tool.
Method ValidateFieldName Checks a field for compatibility with the workspace.
Method ValidateTableName Checks a table name for compatibility with the workspace.

Classes that implement IGpDispatch

Classes Description