BooleanSwitch BooleanSwitch BooleanSwitch BooleanSwitch Class

定義

デバッグ出力およびトレース出力を制御する単純なオン/オフ スイッチを提供します。Provides a simple on/off switch that controls debugging and tracing output.

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

次の例では、作成、BooleanSwitchスイッチを使用するエラー メッセージを表示するかどうかを決定します。The following example creates a BooleanSwitch and uses the switch to determine whether to print an error message. クラス レベルでは、スイッチを作成します。You create the switch at the class level. Mainメソッドは、その場所を渡しますMyMethod、エラー メッセージを出力して、エラーが発生します。The Main method passes its location to MyMethod, which prints an error message and where the error occurred.

public ref class BooleanSwitchTest
{
private:

   /* Create a BooleanSwitch for data.*/
   static BooleanSwitch^ dataSwitch = gcnew BooleanSwitch( "Data","DataAccess module" );

public:
   static void MyMethod( String^ location )
   {
      
      //Insert code here to handle processing.
      if ( dataSwitch->Enabled )
            Console::WriteLine( "Error happened at {0}", location );
   }

};

int main()
{
   
   //Run the method which writes an error message specifying the location of the error.
   BooleanSwitchTest::MyMethod( "in main" );
}

// Class level declaration.
/* Create a BooleanSwitch for data.*/
static BooleanSwitch dataSwitch = new BooleanSwitch("Data", "DataAccess module");

static public void MyMethod(string location) {
   //Insert code here to handle processing.
   if(dataSwitch.Enabled)
      Console.WriteLine("Error happened at " + location);
}

public static void Main(string[] args) {
   //Run the method which writes an error message specifying the location of the error.
   MyMethod("in Main");
}

' Class level declaration.
' Create a BooleanSwitch for data. 
Private Shared dataSwitch As New BooleanSwitch("Data", "DataAccess module")


Public Shared Sub MyMethod(location As String)
    ' Insert code here to handle processing.
    If dataSwitch.Enabled Then
        Console.WriteLine(("Error happened at " + location))
    End If
End Sub 'MyMethod

' Entry point which delegates to C-style main function.
Public Overloads Shared Sub Main()
    Main(System.Environment.GetCommandLineArgs())
End Sub
 
Overloads Public Shared Sub Main(args() As String)
    ' Run the method which writes an error message specifying the location of the error.
    MyMethod("in Main")
End Sub 'Main

注釈

ブール型のトレース スイッチを使用するには有効または重要度に基づいてメッセージを無効にします。You can use a Boolean trace switch to enable or disable messages based on their importance. 使用して、Enabledスイッチの現在の値を取得するプロパティ。Use the Enabled property to get the current value of the switch.

有効または無効にすることができます、BooleanSwitchを通じて、アプリケーション構成ファイルと、使用して、構成されたBooleanSwitchアプリケーション内の値。You can enable or disable a BooleanSwitch through the application configuration file and then use the configured BooleanSwitch value in your application. また、作成することができます、 BooleanSwitch 、コードとセットで、Enabledコードの特定のセクションをインストルメント化するには、直接プロパティ。Alternately, you can create a BooleanSwitch in your code and set the Enabled property directly to instrument a specific section of code.

構成する、BooleanSwitchアプリケーションの名前に対応する構成ファイルを編集します。To configure a BooleanSwitch, edit the configuration file that corresponds to the name of your application. このファイルでことができますを追加またはスイッチの削除、スイッチの値を設定またはオフにするスイッチは以前、アプリケーションによって設定されたすべて。Within 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>  

この例の構成セクションを定義、BooleanSwitchで、DisplayNameプロパティに設定mySwitchEnabled値に設定trueします。This example configuration section defines a BooleanSwitch with the DisplayName property set to mySwitch and the Enabled value set to true. 作成して構成されているスイッチの値を使用する、アプリケーション内に、BooleanSwitchに次のコード例に示すように、同じ名前を持つ。Within your application, you can use the configured switch value by creating a BooleanSwitch with the same name, as shown in the following code example.

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

public:
    static void Main( )
    {
        //...
        Console::WriteLine("Boolean switch {0} configured as {1}",
            boolSwitch->DisplayName, ((Boolean^)boolSwitch->Enabled)->ToString());
        if (boolSwitch->Enabled)
        {
            //...
        }
    }
private static BooleanSwitch boolSwitch = new BooleanSwitch("mySwitch",
    "Switch in config file");

public static void Main( )
{
    //...
    Console.WriteLine("Boolean switch {0} configured as {1}",
        boolSwitch.DisplayName, boolSwitch.Enabled.ToString());
    if (boolSwitch.Enabled)
    {
        //...
    }
}
Private Shared boolSwitch As new BooleanSwitch("mySwitch", _
    "Switch in config file")

Public Shared Sub Main( )
    '...
    Console.WriteLine("Boolean switch {0} configured as {1}",
        boolSwitch.DisplayName, boolSwitch.Enabled.ToString())
    If boolSwitch.Enabled = True Then
        '...
    End If
End Sub

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

トレース出力またはスイッチを使用してデバッグを有効にする必要があります。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 you can 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.

注意

これらのデバッグし、トレースのコンパイラ スイッチを使用する場合は必要ありません、BooleanSwitchクラスに分離します。These debug and trace compiler switches are not required when using the BooleanSwitch 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.

注意

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

コンストラクター

BooleanSwitch(String, String) BooleanSwitch(String, String) BooleanSwitch(String, String) BooleanSwitch(String, String)

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

BooleanSwitch(String, String, String) BooleanSwitch(String, String, String) BooleanSwitch(String, String, String) BooleanSwitch(String, String, String)

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

プロパティ

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)
Enabled Enabled Enabled Enabled

スイッチが有効または無効かを示す値を取得または設定します。Gets or sets a value indicating whether the switch is enabled or disabled.

SwitchSetting SwitchSetting SwitchSetting SwitchSetting

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

(Inherited from Switch)
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()

SwitchSetting プロパティが変更されると発生します。Invoked when the SwitchSetting property is changed.

(Inherited from Switch)
OnValueChanged() OnValueChanged() OnValueChanged() OnValueChanged()

Value プロパティの新しい値がブール値として解析されるかどうかを判断します。Determines whether the new value of the Value property can be parsed as a Boolean value.

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

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

(Inherited from Object)

適用対象

こちらもご覧ください