GetReturnCode

Summary

Return the message error code for a geoprocessing message.

If the message for the specified index is a warning or informative message the function will return a 0; if the message is an error the function will return a value other than 0.

Syntax

GetReturnCode (index)
ParameterExplanationData Type
index

The specified position of the message in the returned list of messages, warnings, or errors.

Integer
Return Value
Data TypeExplanation
Integer

The return code of the message at the specified index position.

Code sample

GetReturnCode example

Returns the severity code for the specified message.

import arcpy

arcpy.env.workspace = "c:/census/data.gdb"
arcpy.analysis.Erase("housing", "income", "low_income")

# Return the return code of the message in index
# position 3 (4th message)
print(arcpy.GetReturnCode(3))

Related topics