You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
314 lines
16 KiB
314 lines
16 KiB
<?xml version="1.0"?> |
|
<doc> |
|
<assembly> |
|
<name>ESRI.ArcGIS.Geoprocessor</name> |
|
</assembly> |
|
<members> |
|
<member name="T:ESRI.ArcGIS.Geoprocessor.IGPProcess"> |
|
<summary> |
|
The interface required by processes intended for use with the Geoprocessor. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.IGPProcess.ToolboxDirectory"> |
|
<summary> |
|
The directory of the toolbox containing the tool from which this process was generated. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.IGPProcess.ToolboxName"> |
|
<summary> |
|
The name of the toolbox containing the tool from which this process was generated. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.IGPProcess.ToolName"> |
|
<summary> |
|
The name of the tool from which this process was generated. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.IGPProcess.Alias"> |
|
<summary> |
|
The alias of the toolbox containing the tool from which this process was generated. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.IGPProcess.ParameterInfo"> |
|
<summary> |
|
For internal use only, do not modify. |
|
</summary> |
|
</member> |
|
<member name="T:ESRI.ArcGIS.Geoprocessor.Geoprocessor"> |
|
<summary> |
|
The Geoprocessor. Provides access to toolboxes and tools. |
|
</summary> |
|
<remarks> |
|
The Geoprocessor contains properties and methods which make it possible the execute tools, set global environment settings, add and remove toolboxes, and examine messages. |
|
</remarks> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.#ctor"> |
|
<summary>Default Constructor</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.#ctor(ESRI.ArcGIS.Server.IServerContext)"> |
|
<summary>Default constructor for use with ArcGIS Server</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddError(System.String)"> |
|
<summary> |
|
Output an error message. When running within a script tool, message becomes part |
|
of the tool messages, otherwise outputs to console |
|
</summary> |
|
<param name="error">Error string to add.</param> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddMessage(System.String)"> |
|
<summary> |
|
Output an informative message. When running within a script tool, message becomes |
|
part of the tool messages, otherwise outputs to console. |
|
</summary> |
|
<param name="message">Message to add.</param> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddReturnMessage(System.Int32)"> |
|
<summary> |
|
Output message from the last tool executed. When running within a script tool, |
|
message becomes part of the tool messages, otherwise outputs to console. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddToolbox(System.String)"> |
|
<summary>Add a toolbox to the current Geoprocessing session by catalog path.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddWarning(System.String)"> |
|
<summary> |
|
Output a warning message. When running within a script tool, message becomes part |
|
of the tool messages, otherwise outputs to console. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ClearMessages"> |
|
<summary> |
|
Clear the messages to be returned as tool message when running within a script |
|
tool. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetDataElement(System.Object,System.Object@)"> |
|
<summary> |
|
Provides access to the Basic Data Element |
|
</summary> |
|
<param name="inputValue">an object</param> |
|
<param name="dataType">a ref object type</param> |
|
<returns>A Basic Data Element</returns> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Execute(System.String,ESRI.ArcGIS.esriSystem.IVariantArray,ESRI.ArcGIS.esriSystem.ITrackCancel)"> |
|
<summary>Execute a tool within the current Geoprocessing session.</summary> |
|
<overloads> |
|
Executes a tool within the current Geoprocessing session using the |
|
IGPProcess. |
|
</overloads> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Execute(ESRI.ArcGIS.Geoprocessor.IGPProcess,ESRI.ArcGIS.esriSystem.ITrackCancel)"> |
|
<summary> |
|
Executes a tool within the current Geoprocessing session using the |
|
IGPProcess. |
|
</summary> |
|
<overloads>Executes a tool within the current Geoprocessing session.</overloads> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Exists(System.Object,System.Object@)"> |
|
<summary> |
|
<para>Test the existence of a given parameter value (GPValue or catalog path) the type |
|
of the data is optional.</para> |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetEnvironmentValue(System.String)"> |
|
<summary> |
|
Retrieve the value of an environment by name. The properties of the current |
|
Geoprocessing session. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetMessage(System.Int32)"> |
|
<summary>Return the message description by index of the last tool executed.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetMessages(System.Object@)"> |
|
<summary>Return all of the message descriptions of the last tool executed.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetParameterValue(System.Int32)"> |
|
<summary> |
|
Return the input command line or script tool parameter by index as a |
|
GPValue. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetReturnCode(System.Int32)"> |
|
<summary> |
|
Return the message error code (Error Messages Only) by index of the last tool |
|
executed. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.GetSeverity(System.Int32)"> |
|
<summary>Return the message severity by index of the last tool executed.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListDatasets(System.String,System.String)"> |
|
<summary>Return the list of feature datasets within the current workspace.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListEnvironments(System.String)"> |
|
<summary> |
|
Return the list of environments (properties) within the current Geoprocessing |
|
session. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListFeatureClasses(System.String,System.String,System.String)"> |
|
<summary> |
|
Return the list of feature classes within the current workspace or feature |
|
dataset within the workspace. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListRasters(System.String,System.String)"> |
|
<summary>Return the list of rasters within the current workspace.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListTables(System.String,System.String)"> |
|
<summary>Return the list of tables within the current workspace.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListToolboxes(System.String)"> |
|
<summary>Return the list of toolboxes within the current Geoprocessing session.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListTools(System.String)"> |
|
<summary> |
|
Get list of GeoProcessor Tools. |
|
</summary> |
|
<param name="wildCard"></param> |
|
<returns></returns> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ListWorkspaces(System.String,System.String)"> |
|
<summary> |
|
Returns a collection of workspaces in the current workspace based on a query string and type. |
|
</summary> |
|
<param name="wildCard"></param> |
|
<param name="workspaceType"></param> |
|
<returns><see cref="T:ESRI.ArcGIS.Geoprocessing.IGpEnumList"/></returns> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.LoadSettings(System.String)"> |
|
<summary> |
|
Load the current settings (toolboxes, environment values, etc) from a file on |
|
disk in XML format. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Open(System.Object)"> |
|
<summary> |
|
Open an objector a namestring. Example a DEFeatureClass object will return an |
|
IFeatureClass. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ParseFieldName(System.String,System.String)"> |
|
<summary> |
|
Parse a field name within the given workspace. This will strip the connected user |
|
and database names. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ParseTableName(System.String,System.String)"> |
|
<summary> |
|
Parse a table name within the given workspace. This will strip the connected user |
|
and database names. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.QualifyFieldName(System.String,System.String)"> |
|
<summary> |
|
Qualify a field name within the given workspace. This will add the connected user |
|
and database names. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.QualifyTableName(System.String,System.String)"> |
|
<summary> |
|
Qualify a table name within the given workspace. This will add the connected user |
|
and database names. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.RegisterGeoProcessorEvents(ESRI.ArcGIS.Geoprocessing.IGeoProcessorEvents)"> |
|
<summary>Register an object to recieve IGeoProcessorEvents.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.RemoveToolbox(System.String)"> |
|
<summary>Remove a toolbox from the current Geoprocessing session by catalog path.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ResetEnvironments"> |
|
<summary>Reset the environments to their initial state.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.SaveSettings(System.String)"> |
|
<summary> |
|
Save the current settings (toolboxes, environment values, etc) to a file on disk |
|
in XML format. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.SetEnvironmentValue(System.String,System.Object)"> |
|
<summary> |
|
Update the value of an environment by name. The properties of the current |
|
Geoprocessing session. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.SetParameterValue(System.Int32,System.Object)"> |
|
<summary>Set the output script tool parameter by index as a GPValue.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.TestSchemaLock(System.String)"> |
|
<summary> |
|
Test for the presence of a schema lock (already open for writing) of a given file |
|
or dataset. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.UnRegisterGeoProcessorEvents(ESRI.ArcGIS.Geoprocessing.IGeoProcessorEvents)"> |
|
<summary>UnRegister an object to stop recieving IGeoProcessorEvents.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Usage(System.String)"> |
|
<summary>Returns the command line usage of a given tool by name.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Validate(System.String,ESRI.ArcGIS.esriSystem.IVariantArray,System.Boolean)"> |
|
<summary> |
|
Validate the parameters (input) of a tool within the current Geoprocessing |
|
session. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.Validate(ESRI.ArcGIS.Geoprocessor.IGPProcess,System.Boolean)"> |
|
<summary> |
|
Validate the parameters (input) of a tool within the current Geoprocessing |
|
session. |
|
</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ValidateFieldName(System.String,System.String)"> |
|
<summary>Validate a field name within the given workspace.</summary> |
|
</member> |
|
<member name="M:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ValidateTableName(System.String,System.String)"> |
|
<summary>Validate a table or feature class name within the given workspace.</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.IGeoProcessor"> |
|
<summary> |
|
Get the IGeoProcessor COM object |
|
<see cref="!:ESRI.ArcGIS.Geoprocessing.IGeoprocessor"/> |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.AddOutputsToMap"> |
|
<summary> |
|
Set whether resulting output datasets should be added to the application display. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.MessageCount"> |
|
<summary> |
|
Return the number of messages of the last tool executed. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.LogHistory"> |
|
<summary>Set whether or not to log the execution of geoprocessing tools.</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.MaxSeverity"> |
|
<summary>Return the maximum severity of the message of the last tool executed.</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.OverwriteOutput"> |
|
<summary> |
|
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. |
|
</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.ParameterCount"> |
|
<summary>Return the number of input command line or script tool parameters.</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.TemporaryMapLayers"> |
|
<summary>Set whether new map layers are temporary by default.</summary> |
|
</member> |
|
<member name="P:ESRI.ArcGIS.Geoprocessor.Geoprocessor.IServerContext"> |
|
<summary> |
|
<para>The ServerContext object used for working with ArcObjects in the GIS |
|
server.</para> |
|
<para class="t"><b>ServerContext</b> is a non-creatable object. References to |
|
non-creatable objects must be obtained through other objects.</para> |
|
</summary> |
|
</member> |
|
</members> |
|
</doc>
|
|
|