TraceSwitch TraceSwitch TraceSwitch TraceSwitch Class

定義

コードの再コンパイルなしでトレース出力およびデバッグ出力を制御するための複数レベルのスイッチを提供します。Provides a multilevel switch to control tracing and debug output without recompiling your code.

public ref class TraceSwitch : System::Diagnostics::Switch
public class TraceSwitch : System.Diagnostics.Switch
type TraceSwitch = class
    inherit Switch
Public Class TraceSwitch
Inherits Switch
継承
TraceSwitchTraceSwitchTraceSwitchTraceSwitch

次のコード例を作成する新しいTraceSwitchスイッチを使用するエラー メッセージを出力するかどうかを決定します。The following code example creates a new TraceSwitch and uses the switch to determine whether to print error messages. スイッチは、クラス レベルで作成されます。The switch is created at the class level. MyMethod 最初のエラー メッセージを書き込む場合、Levelプロパティに設定されてTraceLevel.Errorまたはそれ以降。MyMethod writes the first error message if the Level property is set to TraceLevel.Error or higher. ただし、MyMethod場合、2 つ目のエラー メッセージは書き込まれません、Levelがより小さいTraceLevel.Verboseします。However, MyMethod does not write the second error message if the Level is less than TraceLevel.Verbose.

   // 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.*/
 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();
 }
 
' 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

注釈

トレース スイッチを使用すると、メッセージの重要度に基づいてフィルター処理します。You can use a trace switch to filter out messages based on their importance. TraceSwitchクラスには、 TraceErrorTraceWarningTraceInfo、およびTraceVerboseスイッチのレベルをテストするプロパティ。The TraceSwitch class provides the TraceError, TraceWarning, TraceInfo, and TraceVerbose properties to test the level of the switch. Levelプロパティを取得または設定スイッチのTraceLevelします。The Level property gets or sets the switch's TraceLevel.

レベルを設定することができます、TraceSwitchを通じて、アプリケーション構成ファイルと、使用して、構成されたTraceSwitchアプリケーションのレベル。You can set the level of a TraceSwitch through the application configuration file and then use the configured TraceSwitch level in your application. また、作成することができます、TraceSwitchコードとコードの特定のセクションをインストルメント化するには、直接レベル設定。Alternately, you can create a TraceSwitch in your code and set the level directly to instrument a specific section of code.

構成する、TraceSwitchアプリケーションの構成ファイルを編集します。To configure a TraceSwitch, edit the configuration file for your application. このファイルでことができますを追加またはスイッチの削除、スイッチの値を設定またはオフにするスイッチは以前、アプリケーションによって設定されたすべて。In this file, you can add or remove a switch, set a switch's value, or clear all the switches previously set by the application. 構成ファイルは、次の例のような形式にする必要があります。The configuration file should be formatted like the following example:

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

この構成セクションを定義、TraceSwitchで、DisplayNameに設定mySwitch、およびLevel列挙値に対応するには、1 に設定TraceLevel.Errorします。This configuration section defines a TraceSwitch with the DisplayName set to mySwitch, and the Level set to 1, which corresponds to the enumeration value TraceLevel.Error.

注意

.NET Framework バージョン 2.0 では、スイッチの値を指定するためにテキストを使用できます。In the .NET Framework version 2.0, you can use text to specify the value for a switch. たとえば、trueBooleanSwitchまたは列挙値を表すテキストErrorTraceSwitchします。For example, true for a BooleanSwitch or the text representing an enumeration value, such as Error for a TraceSwitch. <add name="mySwitch" value="Error" /> という行は、<add name="mySwitch" value="1" /> と同じです。The line <add name="mySwitch" value="Error" /> is equivalent to <add name="mySwitch" value="1" />.

アプリケーションでは、作成して構成された切り替えレベルを使用することができます、TraceSwitchに次の例で示すように、同じ名前の。In your application, you can use the configured switch level by creating a TraceSwitch with the same name, as shown in the following example:

private:
    static TraceSwitch^ appSwitch = gcnew TraceSwitch("mySwitch",
        "Switch in config file");

public:
    static void Main(array<String^>^ args)
    {
        //...
        Console::WriteLine("Trace switch {0} configured as {1}",
        appSwitch->DisplayName, appSwitch->Level.ToString());
        if (appSwitch->TraceError)
        {
            //...
        }
    }
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)
    {
        //...
    }
}
Private Shared appSwitch As new TraceSwitch("mySwitch", _
    "Switch in config file")

Public Shared Sub Main(args As String())
    '...
    Console.WriteLine("Trace switch {0} configured as {1}",
    appSwitch.DisplayName, appSwitch.Level.ToString())
    If appSwitch.TraceError = True  Then
        '...
    End If
End Sub

既定では、スイッチLevel構成ファイルで指定された値を使用してプロパティを設定します。By default, the switch Level property is set using the value specified in the configuration file. 場合、TraceSwitchコンス トラクターは、構成ファイルでスイッチの初期設定を見つけることができません、Level新しいスイッチの既定値はTraceLevel.Offします。If the TraceSwitch constructor cannot find initial switch settings in the configuration file, the Level of the new switch defaults to TraceLevel.Off.

トレース出力またはスイッチを使用してデバッグを有効にする必要があります。You must enable tracing or debugging to use a switch. 次の構文では、特定のコンパイラです。The following syntax is compiler specific. C# または Visual Basic 以外のコンパイラを使用する場合は、コンパイラは、ドキュメントを参照してください。If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • C# でのデバッグを有効にするには追加、/d:DEBUGフラグをコードのコンパイルまたは追加するときに、コンパイラのコマンドライン#define DEBUGファイルの先頭にします。To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or add #define DEBUG to the top of your file. Visual Basic では、追加、/d:DEBUG=Trueフラグをコンパイラ コマンドライン。In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • C# でのトレースを有効にするには追加、/d:TRACEフラグをコードのコンパイルまたは追加するときに、コンパイラのコマンドライン#define TRACEファイルの先頭にします。To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. Visual Basic では、追加、/d:TRACE=Trueフラグをコンパイラ コマンドライン。In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

注意

これらのデバッグし、トレースのコンパイラ スイッチを使用する場合は必要ありません、TraceSwitchクラスに分離します。These debug and trace compiler switches are not required when using the TraceSwitch class in isolation. 組み合わせてのみに必要なTraceまたはDebug条件付きでコンパイルされるメソッド。They are only required in conjunction with Trace or Debug methods that are conditionally compiled.

アプリケーションをインストルメント化の詳細については、次を参照してください。DebugTraceします。For more information on instrumenting your application, see Debug and Trace. 構成とトレース スイッチの使用に関する詳細については、次を参照してください。トレース スイッチします。For more information about configuring and using trace switches, see Trace Switches.

注意

パフォーマンスを向上させるのには設定TraceSwitchメンバーstaticクラスにします。To improve performance, you can make TraceSwitch members static in your class.

コンストラクター

TraceSwitch(String, String) TraceSwitch(String, String) TraceSwitch(String, String) TraceSwitch(String, String)

表示名と説明を指定して、TraceSwitch クラスの新しいインスタンスを初期化します。Initializes a new instance of the TraceSwitch class, using the specified display name and description.

TraceSwitch(String, String, String) TraceSwitch(String, String, String) TraceSwitch(String, String, String) TraceSwitch(String, String, String)

スイッチの表示名、説明、および既定値を指定して、TraceSwitch クラスの新しいインスタンスを初期化します。Initializes a new instance of the TraceSwitch class, using the specified display name, description, and default value for the switch.

プロパティ

Attributes Attributes Attributes Attributes

アプリケーション構成ファイルに定義されているカスタム スイッチ属性を取得します。Gets the custom switch attributes defined in the application configuration file.

(Inherited from Switch)
Description Description Description Description

スイッチの説明を取得します。Gets a description of the switch.

(Inherited from Switch)
DisplayName DisplayName DisplayName DisplayName

スイッチを識別するための名前を取得します。Gets a name used to identify the switch.

(Inherited from Switch)
Level Level Level Level

スイッチが許可するメッセージを決定するトレース レベルを取得または設定します。Gets or sets the trace level that determines the messages the switch allows.

SwitchSetting SwitchSetting SwitchSetting SwitchSetting

このスイッチの現在の設定を取得または設定します。Gets or sets the current setting for this switch.

(Inherited from Switch)
TraceError TraceError TraceError TraceError

スイッチがエラー処理メッセージを許可するかどうかを示す値を取得します。Gets a value indicating whether the switch allows error-handling messages.

TraceInfo TraceInfo TraceInfo TraceInfo

スイッチが情報メッセージを許可するかどうかを示す値を取得します。Gets a value indicating whether the switch allows informational messages.

TraceVerbose TraceVerbose TraceVerbose TraceVerbose

スイッチがすべてのメッセージを許可するかどうかを示す値を取得します。Gets a value indicating whether the switch allows all messages.

TraceWarning TraceWarning TraceWarning TraceWarning

スイッチが警告メッセージを許可するかどうかを示す値を取得します。Gets a value indicating whether the switch allows warning messages.

Value Value Value Value

スイッチの値を取得または設定します。Gets or sets the value of the switch.

(Inherited from Switch)

メソッド

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes()

スイッチによってサポートされるカスタム属性を取得します。Gets the custom attributes supported by the switch.

(Inherited from Switch)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
OnSwitchSettingChanged() OnSwitchSettingChanged() OnSwitchSettingChanged() OnSwitchSettingChanged()

このスイッチのレベルを更新して修正します。Updates and corrects the level for this switch.

OnValueChanged() OnValueChanged() OnValueChanged() OnValueChanged()

SwitchSetting プロパティを Value プロパティと等価の整数に設定します。Sets the SwitchSetting property to the integer equivalent of the Value property.

ToString() ToString() ToString() ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(Inherited from Object)

適用対象

こちらもご覧ください