sp_altermessage (Transact-SQL)
適用対象:SQL Server
SQL Server データベース エンジンのインスタンス内のユーザー定義メッセージまたはシステム メッセージの状態を変更します。 ユーザー定義メッセージは、カタログ ビューを sys.messages
使用して表示できます。
構文
sp_altermessage
[ @message_id = ] message_id
, [ @parameter = ] N'parameter'
, [ @parameter_value = ] 'parameter_value'
[ ; ]
引数
[ @message_id = ] message_id
変更 sys.messages
するメッセージのエラー番号。 @message_idは int で、既定値はありません。
[ @parameter = ] N'parameter'
メッセージが Microsoft Windows アプリケーション ログに書き込まれることを示すために、@parameter_valueと共に使用されます。 @parameterは sysname で、既定値はありません。
@parameterに設定WITH_LOG
する必要があります。NULL
@parameterが or NULL
にWITH_LOG
設定され、@parameter_valueの値が指定されているtrue
場合、メッセージは Windows アプリケーション ログに書き込まれます。 @parameterが設定NULL
WITH_LOG
されているか、@parameter_valueの値が指定されている場合、メッセージはfalse
常に Windows アプリケーション ログに書き込まれるわけではありませんが、エラーの発生方法によっては書き込まれる可能性があります。
メッセージが Windows アプリケーション ログに書き込まれる場合は、データベース エンジンエラー ログ ファイルにも書き込まれます。
@parameterを指定する場合は、@parameter_valueも指定する必要があります。
[ @parameter_value = ] 'parameter_value'
エラーが Microsoft Windows アプリケーション ログに書き込まれることを示すために、@parameterと共に使用されます。 @parameter_valueは varchar(5) で、既定値はありません。
- の場合
true
、エラーは常に Windows アプリケーション ログに書き込まれます。 - 場合
false
、エラーは常に Windows アプリケーション ログに書き込まれるわけではありませんが、エラーの発生方法によっては書き込まれる可能性があります。
@parameter_valueを指定する場合は、@parameterも指定する必要があります。
リターン コードの値
0
(成功) または 1
(失敗)。
結果セット
ありません。
解説
このオプションのWITH_LOG
効果は、既存のsp_altermessage
メッセージのログ動作をRAISERROR WITH LOG
変更する点sp_altermessage
を除き、パラメーターの効果と似ています。 メッセージが変更された WITH_LOG
場合、ユーザーがエラーを呼び出す方法に関係なく、常に Windows アプリケーション ログに書き込まれます。 オプションなしでWITH_LOG
実行された場合RAISERROR
でも、エラーは Windows アプリケーション ログに書き込まれます。
システム メッセージは、次を使用 sp_altermessage
して変更できます。
アクセス許可
serveradmin 固定サーバー ロールのメンバーシップが必要です。
例
次の例では、既存のメッセージ 55001
を Windows アプリケーション ログに書き込みます。
EXEC sp_altermessage 55001, 'WITH_LOG', 'true';
GO
関連するコンテンツ
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示