GetIDMessage (arcpy)

Summary

Get the string of the error or warning ID message.

Discussion

GetIDMessage allows you to access ArcGIS tool message codes for use in Python. These message codes are found are documented in Tool errors and warnings.

Syntax

GetIDMessage (message_ID)
ParameterExplanationData Type
message_ID

The geoprocessing message ID.

Integer
Return Value
Data TypeExplanation
String

The message string associated with the message ID.

Code Sample

GetIDMessage example

Access a message string using GetIDMessage and add to the tool messages using AddMessage.

import arcpy

message = arcpy.GetIDMessage(84001)

# The returned value should be:
#   u'Reading data....
arcpy.AddMessage(message)

Related Topics

6/21/2013