Summary
A Result object is returned by geoprocessing tools.
Discussion
The advantage of a Result object is that you can maintain information about the execution of tools, including messages, parameters, and output. These results can be maintained even after several other tools have been run.
Syntax
Result (toolname, resultID)
Parameter | Explanation | Data Type |
toolname | The name of the executed tool. | String |
resultID | The job ID. | Integer |
Properties
Property | Explanation | Data Type |
inputCount (Read Only) | Returns the number of inputs. | Integer |
maxSeverity (Read Only) | Returns the maximum severity of the messages.
| Integer |
messageCount (Read Only) | Returns the number of messages. | Integer |
outputCount (Read Only) | Returns the number of outputs. | Integer |
resultID (Read Only) | Gets the job ID. If the tool is not a geoprocessing service, the resultID will be "". | String |
status (Read Only) | Gets the job status.
| Integer |
Method Overview
Method | Explanation |
cancel () | Cancels an associated job |
getInput (index) | Returns a given input, either as a recordset or string. |
getMapImageURL ({parameter_list}, {height}, {width}, {resolution}) | Gets a map service image for a given output, if one exists. |
getMessage (index) | Returns a specific message. |
getMessages ({severity}) | Returns messages. |
getOutput (index) | Returns a given output, either as a recordset or a string. |
getSeverity (index) | Returns the severity of a specific message. |
saveToFile (rlt_file) | Saves the result to a result file (.rlt). |
Methods
cancel ()
getInput (index)
Parameter | Explanation | Data Type |
index | The index position of the input. | Integer |
Return Value
Data Type | Explanation |
Object | The input, either as a recordset or string. |
getMapImageURL ({parameter_list}, {height}, {width}, {resolution})
Parameter | Explanation | Data Type |
parameter_list | Parameter(s) on which the map service image will be based. | Integer |
height | The height of the image. | Double |
width | The width of the image. | Double |
resolution | The resolution of the image. | Double |
Return Value
Data Type | Explanation |
String | The URL of the map image. |
getMessage (index)
Parameter | Explanation | Data Type |
index | The index position of the message. | Integer |
Return Value
Data Type | Explanation |
String | The geoprocessing message. |
getMessages ({severity})
Parameter | Explanation | Data Type |
severity | The type of messages to be returned: 0=message, 1=warning, 2=error. Not specifying a value returns all message types.
(The default value is 0) | Integer |
Return Value
Data Type | Explanation |
String | The geoprocessing messages. |
getOutput (index)
Parameter | Explanation | Data Type |
index | The index position of the outputs. | Integer |
Return Value
Data Type | Explanation |
Object | The output, either as a recordset or a string. Result outputs can also be accessed by index, so result.getOutput(0) and result[0] are equivalent. |
getSeverity (index)
Parameter | Explanation | Data Type |
index | The message index position. | Integer |
Return Value
Data Type | Explanation |
Integer | The severity of the specific message.
|
saveToFile (rlt_file)
Parameter | Explanation | Data Type |
rlt_file | Full path to the output result file (.rlt). | String |
Code sample
Result example 1
Use the result object returned from GetCount to determine the count of a table.
import arcpy
in_table = arcpy.GetParameterAsText(0)
result = arcpy.GetCount_management(in_table)
print(result[0])
Result example 2
Obtain the feature set schema from the server tool, load data to the feature set, pass the feature set to the server tool, and check for the result object. Once completed, save the result to the local dataset.
import time
import arcpy
# Add a toolbox from a server
arcpy.ImportToolbox("http://myserver/arcgis/services;GP/BufferByVal",
"servertools")
# Use GetParameterValue to get a featureset object with the default
# schema of the first parameter of the tool 'bufferpoints'
in_featureset = arcpy.GetParameterValue("bufferpoints", 0)
# Load a shapefile into the featureset
in_featureset.load("C:/Data/roads.shp")
# Run a server tool named BufferPoints with featureset created above
result = arcpy.BufferPoints_server(in_featureset, "500 feet")
# Check the status of the result object every 0.2 seconds
# until it has a value of 4 (succeeded) or greater
while result.status < 4:
time.sleep(0.2)
# Get the output FeatureSet back from the server and save to a local geodatabase
out_featureset = result.getOutput(0)
out_featureset.save("c:/temp/base.gdb/roads_buffer")
Result example 3
Re-create the original geoprocessing service output using the tool name and result id.
import arcpy
# Add the toolbox from the server
arcpy.ImportToolbox("http://myserver/arcgis/services;GP/BufferByVal")
# Recreate the original output using the tool name and result id
result_id = 'jfea96e13ba7b443cb04ba47c19899a1b'
result = arcpy.Result("BufferPoints", result_id)