AddError

Summary

Adds an error message (severity of 2) to the messages of a script tool or Python toolbox tool.

When a tool is run, an error message can be accessed from the Geoprocessing pane, the geoprocessing history, and the list of messages when a tool is called from Python.

Syntax

AddError (message)
ParameterExplanationData Type
message

The error message.

String

Code sample

AddError example

Add an error message to a Python script tool.

import arcpy

fc = arcpy.GetParameterAsText(0)

# Get the count from the GetCount tool's Result object
feature_count = int(arcpy.GetCount_management(fc)[0])

if feature_count == 0:
    arcpy.AddError("{0} has no features.".format(fc))
else:
    arcpy.AddMessage("{0} has {1} features.".format(fc, feature_count))

Related topics