ESRI.ArcGIS.Geoprocessor
Geoprocessor Class Members
See Also  Properties  Methods  Events Send your comments to: Site Administrator | Terms of Use | PRIVACY | Copyright @ ESRI | Careers
ESRI.ArcGIS.Geoprocessor Namespace : Geoprocessor Class




The following tables list the members exposed by Geoprocessor.

Public Constructors

 NameDescription
Public ConstructorGeoprocessor ConstructorOverloaded. Default Constructor  
Top

Public Properties

 NameDescription
Public PropertyAddOutputsToMap Set whether resulting output datasets should be added to the application display.  
Public PropertyIGeoProcessor Get the IGeoProcessor COM object IGeoprocessor  
Public PropertyIServerContextThe ServerContext object used for working with ArcObjects in the GIS server.

ServerContext is a non-creatable object. References to non-creatable objects must be obtained through other objects.  

Public PropertyLogHistorySet whether or not to log the execution of geoprocessing tools.  
Public PropertyMaxSeverityReturn the maximum severity of the message of the last tool executed.  
Public PropertyMessageCount Return the number of messages of the last tool executed.  
Public PropertyOverwriteOutput If this is true, then the output of process execution will overwrite existing output of the same name. If this is false and files of the same name as those output by process execution exist, the process execution will fail without overwriting the original files.  
Public PropertyParameterCountReturn the number of input command line or script tool parameters.  
Public PropertyTemporaryMapLayersSet whether new map layers are temporary by default.  
Top

Public Methods

 NameDescription
Public MethodAddError Output an error message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console  
Public MethodAddMessage Output an informative message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console.  
Public MethodAddReturnMessage Output message from the last tool executed. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console.  
Public MethodAddToolboxAdd a toolbox to the current Geoprocessing session by catalog path.  
Public MethodAddWarning Output a warning message. When running within a script tool, message becomes part of the tool messages, otherwise outputs to console.  
Public MethodClearMessages Clear the messages to be returned as tool message when running within a script tool.  
Public MethodExecuteOverloaded.  Executes a tool within the current Geoprocessing session using the IGPProcess.  
Public MethodExecuteAsyncOverloaded. Executes a tool asynchronously within the current Geoprocessing session.  
Public MethodExistsTest the existence of a given parameter value (GPValue or catalog path) the type of the data is optional.  
Public MethodGetDataElement Provides access to the Basic Data Element  
Public MethodGetEnvironmentValue Retrieve the value of an environment by name. The properties of the current Geoprocessing session.  
Public MethodGetMessageReturn the message description by index of the last tool executed.  
Public MethodGetMessagesReturn all of the message descriptions of the last tool executed.  
Public MethodGetParameterValue Return the input command line or script tool parameter by index as a GPValue.  
Public MethodGetReturnCode Return the message error code (Error Messages Only) by index of the last tool executed.  
Public MethodGetSeverityReturn the message severity by index of the last tool executed.  
Public MethodListDatasetsReturn the list of feature datasets within the current workspace.  
Public MethodListEnvironments Return the list of environments (properties) within the current Geoprocessing session.  
Public MethodListFeatureClasses Return the list of feature classes within the current workspace or feature dataset within the workspace.  
Public MethodListRastersReturn the list of rasters within the current workspace.  
Public MethodListTablesReturn the list of tables within the current workspace.  
Public MethodListToolboxesReturn the list of toolboxes within the current Geoprocessing session.  
Public MethodListTools Get list of GeoProcessor Tools.  
Public MethodListWorkspaces Returns a collection of workspaces in the current workspace based on a query string and type.  
Public MethodLoadSettings Load the current settings (toolboxes, environment values, etc) from a file on disk in XML format.  
Public MethodOpen Open an objector a namestring. Example a DEFeatureClass object will return an IFeatureClass.  
Public MethodParseFieldName Parse a field name within the given workspace. This will strip the connected user and database names.  
Public MethodParseTableName Parse a table name within the given workspace. This will strip the connected user and database names.  
Public MethodQualifyFieldName Qualify a field name within the given workspace. This will add the connected user and database names.  
Public MethodQualifyTableName Qualify a table name within the given workspace. This will add the connected user and database names.  
Public MethodRegisterGeoProcessorEventsRegister an object to recieve IGeoProcessorEvents.  
Public MethodRemoveToolboxRemove a toolbox from the current Geoprocessing session by catalog path.  
Public MethodResetEnvironmentsReset the environments to their initial state.  
Public MethodSaveSettings Save the current settings (toolboxes, environment values, etc) to a file on disk in XML format.  
Public MethodSetEnvironmentValue Update the value of an environment by name. The properties of the current Geoprocessing session.  
Public MethodSetParameterValueSet the output script tool parameter by index as a GPValue.  
Public MethodTestSchemaLock Test for the presence of a schema lock (already open for writing) of a given file or dataset.  
Public MethodUnRegisterGeoProcessorEventsUnRegister an object to stop recieving IGeoProcessorEvents.  
Public MethodUsageReturns the command line usage of a given tool by name.  
Public MethodValidateOverloaded.  Validate the parameters (input) of a tool within the current Geoprocessing session.  
Public MethodValidateFieldNameValidate a field name within the given workspace.  
Public MethodValidateTableNameValidate a table or feature class name within the given workspace.  
Top

Public Events

 NameDescription
Public EventMessagesCreated Fires when a Message has been created.  
Public EventProgressChanged Fires when the Progress has changed.  
Public EventToolboxChanged Fires when the Toolbox has changed.  
Public EventToolExecuted  
Public EventToolExecuting Fires when the Tool starts executing.  
Top

See Also

© 2010 All Rights Reserved.