The Geoprocessor. Provides access to toolboxes and tools.
Product Availability
Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.
When To Use
The IGeoprocessor contains properties and methods to execute tools, set global environment settings, add and remove toolboxes, and examine messages.
Refer to samples for executing geoprocressing tools.
Members
Description | ||
---|---|---|
AddError | Output an error message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console | |
AddMessage | Output an informative message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console | |
AddOutputsToMap | Set whether resulting output datasets should be added to the application display. | |
AddReturnMessage | Output message from the last tool executed. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console | |
AddToolbox | Add a toolbox to the current Geoprocessing session by catalog path. | |
AddWarning | Output a warning message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console | |
ClearMessages | Clear the messages to be returned as tool message when running within a script tool. | |
CreateResult | Create a new result object. | |
Execute | Execute a tool within the current Geoprocessing session. | |
Exists | Test the existence of a given parameter value (GPValue or catalog path) the type of the data is optional. | |
GetDataElement | Make a dataelement from the given value. | |
GetEnvironmentValue | Retrieve the value of an environment by name. The properties of the current Geoprocessing session. | |
GetMessage | Return the message description by index of the last tool executed. | |
GetMessages | Return all of the message descriptions of the last tool executed. | |
GetParameterValue | Return the input command line or script tool parameter by index as a GPValue. | |
GetReturnCode | Return the message error code (Error Messages Only) by index of the last tool executed. | |
GetReturnMessages | Return the GPMessages object which will be messages of the last tool executed. | |
GetSeverity | Return the message severity by index of the last tool executed. | |
IsSynchronous | Is server tool synchronous. | |
ListDatasets | Return the list of feature datasets within the current workspace. | |
ListEnvironments | Return the list of environments (properties) within the current Geoprocessing session. | |
ListFeatureClasses | Return the list of feature classes within the current workspace or feature dataset within the workspace. | |
ListRasters | Return the list of rasters within the current workspace. | |
ListTables | Return the list of tables within the current workspace. | |
ListToolboxes | Return the list of toolboxes within the current Geoprocessing session. | |
ListTools | Return the list of tools within the current Geoprocessing session. | |
ListWorkspaces | Return the list of workspaces within the current workspace (the workspace can be a folder). | |
LoadSettings | Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format. | |
LogHistory | Set whether or not to log the execution of geoprocessing tools. | |
MaxSeverity | Return the maximum severity of the message of the last tool executed. | |
MessageCount | Return the number of messages of the last tool executed. | |
Open | Open an objector a namestring. Example a DEFeatureClass object will return an IFeatureClass. | |
OverwriteOutput | Set the overwrite outputs flag within the current Geoprocessing session. True means outputs of tools will be overwritten. | |
ParameterCount | Return the number of input command line or script tool parameters. | |
ParseFieldName | Parse a field name within the given workspace. This will strip the connected user and database names. | |
ParseTableName | Parse a table name within the given workspace. This will strip the connected user and database names. | |
QualifyFieldName | Qualify a field name within the given workspace. This will add the connected user and database names. | |
QualifyTableName | Qualify a table name within the given workspace. This will add the connected user and database names. | |
RegisterGeoProcessorEvents | Register an object to recieve IGeoProcessorEvents. | |
RemoveToolbox | Remove a toolbox from the current Geoprocessing session by catalog path. | |
ResetEnvironments | Reset the environments to their initial state. | |
SaveSettings | Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format. | |
SetEnvironmentValue | Update the value of an environment by name. The properties of the current Geoprocessing session. | |
SetParameterValue | Set the output script tool parameter by index as a GPValue. | |
TemporaryMapLayers | Set whether new map layers are temporary by default. | |
TestSchemaLock | Test for the presence of a schema lock (already open for writing) of a given file or dataset. | |
UnRegisterGeoProcessorEvents | UnRegister an object to stop recieving IGeoProcessorEvents. | |
Usage | Returns the command line usage of a given tool by name. | |
Validate | Validate the parameters (input) of a tool within the current Geoprocessing session. | |
ValidateFieldName | Validate a field name within the given workspace. | |
ValidateTableName | Validate a table or feature class name within the given workspace. |
CoClasses that implement IGeoProcessor
CoClasses and Classes | Description |
---|---|
GeoProcessor | GeoProcessor Access. |