AddMessage

This ArcGIS 3.1 documentation has been archived and is no longer updated. Content and links may be outdated. See the latest documentation.

Summary

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

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

Syntax

AddMessage (message)
ParameterExplanationData Type
message

The informative message.

String

Code sample

AddMessage example

Add an informative message to a Python script tool.

import arcpy

fc = arcpy.GetParameterAsText(0)

# Get the count from GetCount's Result object
feature_count = int(arcpy.GetCount_management(fc).getOutput(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