AddIDMessage

描述

可以通过脚本工具使用系统消息。

了解地理处理工具的错误和警告信息下面列出了可用的消息和 ID 列表。

讨论

地理处理过程中错误和警告信息由地理处理工具返回，形式为一个六位数代码和一条文本消息。每个错误和警告在桌面帮助系统中都有对应的描述页面。该页面包含详细的错误描述以及针对该错误的可行解决方案。工具对话框、Python 窗口以及结果窗口中的 ID 代码是一个链接，用户单击该链接后会进入描述页面。

语法

AddIDMessage (message_type, message_ID, {add_argument1}, {add_argument2})

参数	说明	数据类型
message_type	消息类型定义消息为错误消息、警告消息还是信息性消息。有效消息类型如下： ERROR —向工具消息添加错误消息 INFORMATIVE —向工具消息添加信息性消息 WARNING —向工具消息添加警告消息	String
message_ID	消息 ID 允许您参考脚本错误和警告的现有消息。	Integer
add_argument1	根据所使用的消息 ID，可能需要使用参数来完成消息。常见的示例包括数据集或字段名称。数据类型可以是字符串类型、整型或双精度型。	Object
add_argument2	根据所使用的消息 ID，可能需要使用参数来完成消息。常见的示例包括数据集或字段名称。数据类型可以是字符串类型、整型或双精度型。	Object

代码示例

AddIDMessage 示例

向 Python 脚本工具添加消息。

class overwriteError(Exception):
    pass
import arcpy
in_feature_class = arcpy.GetParameterAsText(0)
out_feature_class = arcpy.GetParameterAsText(1)
try:
    # If the output feature class already exists, raise an error
    if arcpy.Exists(in_feature_class):
        # Raise a custom exception
        raise overwriteError(out_feature_class)
    else:
        arcpy.CopyFeatures_management(in_feature_class, out_feature_class)
except overwriteError as err:
    # Use message ID 12, and provide the output feature class
    #    to complete the message.
    arcpy.AddIDMessage("Error", 12, str(err))