sp_trace_setstatus （Transact-SQL）

適用対象: SQL Server

指定したトレースの現在の状態を変更します。

重要

この機能は、 SQL Serverの将来のバージョンで削除される予定です。新規の開発作業ではこの機能を使用しないようにし、現在この機能を使用しているアプリケーションは修正することを検討してください。代わりに拡張イベントを使用します。

構文

sp_trace_setstatus
    [ @traceid = ] traceid
    , [ @status = ] status
[ ; ]

変更するトレースの ID。 @traceid は int で、既定値はありません。ユーザーはこの @traceid 値を使用して、トレースを識別、変更、および制御します。 @traceidの取得については、sys.fn_trace_getinfoを参照してください。

トレースに実装する操作を指定します。 @status は int で、既定値はありません。

次の表に、指定できる状態を示します。

状態	説明
`0`	指定したトレースを停止します。
`1`	指定したトレースを開始します。
`2`	指定したトレースを閉じ、その定義をサーバーから削除します。

Note

トレースを閉じるには、最初にそのトレースを停止する必要があります。トレースを表示するには、最初にそのトレースを停止して閉じる必要があります。

次の表では、ストアドプロシージャの完了後に取得できるコード値について説明します。

リターンコード	説明
`0`	エラーなし。
`1`	不明なエラー。
`8`	指定された状態が無効です。
`9`	指定されたトレースハンドルが無効です。
`13`	メモリが不足しています。指定されたアクションを実行するのに十分なメモリがない場合に返されます。

トレースが既に指定された状態にある場合、SQL Server は 0を返します。

すべての SQL トレースストアドプロシージャ (sp_trace_*) のパラメーターは厳密に型指定されます。これらのパラメーターが、引数の説明で指定されている正しいデータ型で呼び出されないと、このストアドプロシージャではエラーが返されます。

トレースストアドプロシージャの使用例については、「トレースの作成を参照してください。

ALTER TRACE 権限が必要です。