IGpDispatch Interface

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

Product Availability

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

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