TraceSwitch クラスとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

TraceSwitch クラス

コードを再コンパイルせずに、トレースやデバッグの出力を制御する複数レベルのスイッチを提供します。

名前空間: System.Diagnostics
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class TraceSwitch
    Inherits Switch

Visual Basic (使用法)

Dim instance As TraceSwitch

public class TraceSwitch : Switch

C++

public ref class TraceSwitch : public
 Switch

public class TraceSwitch extends Switch

JScript

public class TraceSwitch extends
 Switch

解説

トレーススイッチを使用すると、メッセージの重要度に基づいてメッセージのフィルタ処理を行うことができます。TraceSwitch クラスは、スイッチのレベルをテストする TraceError、TraceWarning、TraceInfo、および TraceVerbose の各プロパティを提供します。Level プロパティは、スイッチの TraceLevel を取得または設定します。

アプリケーション構成ファイルで TraceSwitch のレベルを設定し、構成した TraceSwitch レベルをアプリケーションで使用できます。または、TraceSwitch をコード内に作成し、レベルを直接設定してコードの特定のセクションをインストルメントすることもできます。

TraceSwitch を構成するには、アプリケーションの名前に対応した構成ファイルを編集します。このファイルでは、スイッチの追加または削除、スイッチの値の設定、アプリケーションで以前設定されたすべてのスイッチのクリアを実行できます。構成ファイルの書式は次の例のようになります。

<configuration>
  <system.diagnostics>
    <switches>
      <add name="mySwitch" value="1" />
    </switches>
  </system.diagnostics>
</configuration>

この構成セクションで TraceSwitch を定義するには、DisplayName を mySwitch に設定し、Level を 1 に設定します。これは列挙値 TraceLevel.Error に対応します。アプリケーション内で、構成したスイッチレベルを使用するには、次の例に示すように TraceSwitch を同じ名前で作成します。

Visual Basic

Private Shared appSwitch As
 New TraceSwitch("mySwitch", _
"Switch in config file")
Public Shared Sub Main(ByVal
 CmdArgs() As String)
'...
    Console.WriteLine("Trace switch {0} configured as {1}",
 _
    appSwitch.DisplayName, appSwitch.Level.ToString())
    If appSwitch.TraceError Then
        '...
    End If
End Sub

private static TraceSwitch appSwitch = new
 TraceSwitch("mySwitch", 
"Switch in config file");

public static void Main(string[]
 args) 
{
    //...
    Console.WriteLine("Trace switch {0} configured as {1}",
 
    appSwitch.DisplayName, appSwitch.Level.ToString());
    if (appSwitch.TraceError)
    {
        //...
    }
}

既定では、スイッチ Level プロパティは、構成ファイルで指定した値を使用して設定されます。TraceSwitch コンストラクタが構成ファイルの初期スイッチ設定を検出できない場合は、新しいスイッチの Level が既定の TraceLevel.Off に設定されます。

スイッチを使用するには、トレースまたはデバッグを有効にする必要があります。次の構文はコンパイラに固有です。C# または Visual Basic 以外のコンパイラを使用する場合は、使用するコンパイラのドキュメントを参照してください。

C# でデバッグを有効にするには、コードのコンパイル時に /d:DEBUG フラグをコンパイラのコマンドラインに追加するか、#define DEBUG をファイルの最上部に挿入します。Visual Basic では、コンパイラのコマンドラインに /d:DEBUG=True フラグを追加します。
C# でトレースを有効にするには、コードのコンパイル時に /d:TRACE フラグをコンパイラのコマンドラインに追加するか、#define TRACE をファイルの最上部に挿入します。Visual Basic では、コンパイラのコマンドラインに /d:TRACE=True フラグを追加します。

メモ
これらのデバッグおよびトレースのコンパイラスイッチは、TraceSwitch クラスを単独で使用する場合には必要ありません。これらが必要になるのは、Trace クラスまたは Debug クラスの条件付きコンパイルされたメソッドと組み合わせて使用する場合だけです。

アプリケーション導入の詳細については、Debug および Trace のトピックを参照してください。トレーススイッチの構成と使用の詳細については、「トレーススイッチ」を参照してください。

メモ
クラスの TraceSwitch のメンバを static にすることで、パフォーマンスを向上させることができます。

Topic	Location
方法 : トレーススイッチを作成し初期化する	.NET Framework: デバッグ
方法 : トレーススイッチを設定する	.NET Framework: デバッグ

使用例

新しい TraceSwitch を作成し、スイッチを使用してエラーメッセージを出力するかどうかを決定するコード例を次に示します。スイッチはクラスレベルで作成されます。MyMethod は、Level プロパティが TraceLevel.Error 以上に設定されている場合に最初のエラーメッセージを書き込みます。ただし、MyMethod は、Level が TraceLevel.Verbose 未満の場合は第 2 のエラーメッセージを書き込みません。

Visual Basic

' Class-level declaration.
' Create a TraceSwitch to use in the entire application. 
Private Shared mySwitch As
 New TraceSwitch("General", "Entire
 Application")    

Public Shared Sub MyMethod()
    ' Write the message if the TraceSwitch level is set to Error or
 higher.
    If mySwitch.TraceError Then
        Console.WriteLine("My error message.")
    End If 
    ' Write the message if the TraceSwitch level is set to Verbose.
    If mySwitch.TraceVerbose Then
        Console.WriteLine("My second error message.")
    End If
End Sub

Public Shared Sub Main()
    ' Run the method that prints error messages based on the switch
 level.
    MyMethod()
End Sub

//Class-level declaration.
 /* Create a TraceSwitch to use in the entire application.*/
 static TraceSwitch mySwitch = new TraceSwitch("General",
 "Entire Application");
 
 static public void MyMethod()
 {
    // Write the message if the TraceSwitch level is set to Error or
 higher.
    if(mySwitch.TraceError)
       Console.WriteLine("My error message.");
 
    // Write the message if the TraceSwitch level is set to Verbose.
    if(mySwitch.TraceVerbose)
       Console.WriteLine("My second error message.");
 }
 
 public static void Main(string[]
 args) {
    // Run the method that prints error messages based on the switch
 level.
    MyMethod();
 }

C++

   // Class-level declaration.
   /* Create a TraceSwitch to use in the entire application.*/
private:
   static TraceSwitch^ mySwitch = gcnew TraceSwitch( "General",
 "Entire Application" );

public:
   static void MyMethod()
   {
      // Write the message if the TraceSwitch level is set to Error or
 higher.
      if ( mySwitch->TraceError )
         Console::WriteLine( "My error message." );
      
      // Write the message if the TraceSwitch level is set to Verbose.
      if ( mySwitch->TraceVerbose )
         Console::WriteLine( "My second error message." );
   }

   static void main()
   {
      // Run the method that prints error messages based on the switch
 level.
      MyMethod();
   }

// Class-level declaration.
/* Create a TraceSwitch to use in the entire application.
 */
private static TraceSwitch mySwitch =
    new TraceSwitch("General", "Entire Application");

public static void MyMethod()
{
    //Write the message if the TraceSwitch level is set to Error or
 higher.
    if (mySwitch.get_TraceError()) {
        Console.WriteLine("My error message.");
    }

    // Write the message if the TraceSwitch level is set to Verbose.
    if (mySwitch.get_TraceVerbose()) {
        Console.WriteLine("My second error message.");
    }
} //MyMethod

public static void main(String[]
 args)
{
    // Run the method that prints error messages based on the switch
 level.
    MyMethod();
} //main