sp_trace_setstatus (Transact-SQL)

適用対象:SQL Server

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

重要

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

Transact-SQL 構文表記規則

構文

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

引数

[ @traceid = ] traceid

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

[ @status = ] 状態

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

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

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

Note

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

リターン コードの値

次の表は、このストアド プロシージャの完了時に返されるコード値を示しています。

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

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

解説

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

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

アクセス許可

ALTER TRACE 権限が必要です。