ERROR_MESSAGE (Transact-SQL)

  • [アーティクル]

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW) Microsoft Fabric の SQL 分析エンドポイント Microsoft Fabric のウェアハウス

この関数は、TRY...CATCH 構造の CATCH ブロックが実行される原因となったエラーのメッセージ テキストを返します。

Transact-SQL 構文表記規則

構文

ERROR_MESSAGE ( )

戻り値の型

nvarchar (4000)

戻り値

ERROR_MESSAGE は、CATCH ブロック内で呼び出されると、CATCH ブロックが実行される原因となったエラー メッセージの全テキストを返します。 このテキストには、長さ、オブジェクト名、時刻など、置換可能なパラメーターに指定された値が含まれます。

ERROR_MESSAGE は、CATCH ブロックの範囲外で呼び出されると、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 を使用する

この例は、0 除算エラーを生成する 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 を使用する

この例は、0 除算エラーを生成する 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)
エラーおよびイベント リファレンス (データベース エンジン)