GetReturnCode (arcpy)

Summary

Return the message error code by index.

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)

Parameter	Explanation	Data Type
index	The specified position of the message in the returned list of messages, warnings, or errors.	Integer

Return Value

Data Type	Explanation
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.Erase_analysis("housing", "income", "low_income")

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