ERROR_MESSAGE (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例Azure Synapse AnalyticsAnalytics Platform System (PDW)Microsoft Fabric 中的 SQL 分析终结点Microsoft Fabric 中的仓库

此函数返回错误的消息文本，该错误导致执行了 TRY…CATCH 构造的 CATCH 块。

Transact-SQL 语法约定

语法

ERROR_MESSAGE ( )

注意

若要查看 SQL Server 2014 (12.x) 及更早版本的 Transact-SQL 语法，请参阅早期版本文档。

返回类型

nvarchar(4000)

返回值

在 CATCH 块中调用时，ERROR_MESSAGE 返回导致 CATCH 块运行的错误消息的完整文本。 该文本包括为所有可替换参数提供的值，例如长度、对象名或时间。

在 CATCH 块作用域外调用时，ERROR_MESSAGE 返回 NULL。

备注

ERROR_MESSAGE 支持在 CATCH 块作用域内的任意位置调用。

无论 ERROR_MESSAGE 运行多少次或在 CATCH 块作用域内的任意位置运行，它都将返回相关的错误消息。 这与 @@ERROR 之类的函数不同，后者只在导致错误的语句的后一个语句中返回错误号。

在嵌套 CATCH 块中，ERROR_MESSAGE 返回特定于引用该 CATCH 块的 CATCH 块的作用域的错误消息。 例如，外部 TRY...CATCH 构造的 CATCH 块可能具有内部 TRY...CATCH 构造。 在该内部 CATCH 块内，ERROR_MESSAGE 将返回调用内部 CATCH 块的错误消息。 如果 ERROR_MESSAGE 在外部 CATCH 块中运行，它将返回调用该外部 CATCH 块的错误消息。

示例

A. 在 CATCH 块中使用 ERROR_MESSAGE

此示例显示生成被零除错误的 SELECT 语句。 CATCH 块返回错误消息。

BEGIN TRY  
    -- Generate a divide-by-zero error.  
    SELECT 1/0;  
END TRY  
BEGIN CATCH  
    SELECT ERROR_MESSAGE() AS ErrorMessage;  
END CATCH;  
GO

下面是结果集：

-----------

(0 row(s) affected)

ErrorMessage
----------------------------------
Divide by zero error encountered.

(1 row(s) affected)

B. 在 CATCH 块中将 ERROR_MESSAGE 与其他错误处理工具一起使用

此示例显示生成被零除错误的 SELECT 语句。 CATCH 块将返回错误消息和有关此错误的信息。

BEGIN TRY  
    -- Generate a divide-by-zero error.  
    SELECT 1/0;  
END TRY  
BEGIN CATCH  
    SELECT  
        ERROR_NUMBER() AS ErrorNumber  
        ,ERROR_SEVERITY() AS ErrorSeverity  
        ,ERROR_STATE() AS ErrorState  
        ,ERROR_PROCEDURE() AS ErrorProcedure  
        ,ERROR_LINE() AS ErrorLine  
        ,ERROR_MESSAGE() AS ErrorMessage;  
END CATCH;  
GO

下面是结果集。

-----------

(0 row(s) affected)

ErrorNumber ErrorSeverity ErrorState  ErrorProcedure  ErrorLine  ErrorMessage
----------- ------------- ----------- --------------- ---------- ----------------------------------
8134        16            1           NULL            4          Divide by zero error encountered.

(1 row(s) affected)

另请参阅

sys.messages (Transact-SQL)
TRY...CATCH (Transact-SQL)
ERROR_LINE (Transact-SQL)
ERROR_MESSAGE (Transact-SQL)
ERROR_PROCEDURE (Transact-SQL)
ERROR_SEVERITY (Transact-SQL)
ERROR_STATE (Transact-SQL)
RAISERROR (Transact-SQL)
@@ERROR (Transact-SQL)
错误和事件参考（数据库引擎）