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


IGeoProcessor2 Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Geoprocessing > ESRI.ArcGIS.Geoprocessing > Interfaces > IG > IGeoProcessor2 Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Geoprocessing)  

IGeoProcessor2 Interface

The Geoprocessor. Provides access to toolboxes and tools.

Product Availability

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

Members

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

CoClasses that implement IGeoProcessor2

CoClasses and Classes Description
GeoProcessor GeoProcessor Access.

.NET Samples

Consuming a geoprocessing custom model in .NET (Code Files: Module1) | Geoprocessing events listener (Code Files: GPEventListner)

.NET Related Topics

Consuming a geoprocessing model tool in .NET | Errors and exception handling in geoprocessing | Executing tools | How to create a script tool that runs an EXE | How to execute a geoprocessing tool using an add-in | How to run a geoprocessing tool | Listing fields | Using ArcObjects as tool input | Using environment settings | Working with ArcSDE data