Return information on a specific tool (or task) in a geoprocessing service.
GetToolInfo(string ToolName)
|
Parameter |
Description |
|
ToolName |
The name of a tool within a geoprocessing service.
|
Return Value
A GPToolInfo object.
Remarks
The signature and default values for a given
tool can be obtained by calling the GetToolInfo() method. This method
returns a GPToolInfo instance, which contains information about the tool’s
parameters.
The GPToolInfo structure includes information on the parameters for the tool. In addition it includes the name, helpstring, and extent for the tool. The extent property supplies the client application with the valid extent of the tool. The tool extent will be based on the model environment setting. The extent is optional.
A GPToolInfo instance has an array of GPParameterInfo. Each GPParameterInfo structure describes a specific parameter. Each parameter has a name, a direction (Input or Output), a parameter type (Required or Optional), a DataType (for eg Double), a ChoiceList (a list of acceptable values for the parameter expressed as a list of strings), and a default value.
Examples