BooleanSwitch Klass

Definition

Tillhandahåller en enkel på/av-växel som styr felsöknings- och spårningsutdata.

public ref class BooleanSwitch : System::Diagnostics::Switch
public class BooleanSwitch : System.Diagnostics.Switch
type BooleanSwitch = class
    inherit Switch
Public Class BooleanSwitch
Inherits Switch
Arv
BooleanSwitch

Exempel

I följande exempel skapas en BooleanSwitch och används växeln för att avgöra om ett felmeddelande ska skrivas ut. Du skapar växeln på klassnivå. Metoden Main skickar platsen till MyMethod, som skriver ut ett felmeddelande och var felet inträffade.

// 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

' 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

Kommentarer

Du kan använda en boolesk spårningsväxel för att aktivera eller inaktivera meddelanden baserat på deras betydelse. Använd egenskapen Enabled för att hämta det aktuella värdet för växeln.

Du kan skapa en BooleanSwitch i koden och ange Enabled egenskapen direkt för att instrumentera ett visst kodavsnitt.

Endast för .NET Framework-appar kan du aktivera eller inaktivera ett BooleanSwitch via programkonfigurationsfilen och sedan använda det konfigurerade värdet BooleanSwitch i ditt program. Om du vill konfigurera en BooleanSwitchredigerar du konfigurationsfilen som motsvarar namnet på ditt program. I den här filen kan du lägga till eller ta bort en växel, ange en växels värde eller rensa alla växlar som tidigare angetts av programmet. Konfigurationsfilen ska formateras som i följande exempel.

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

Det här exempelkonfigurationsavsnittet definierar en BooleanSwitch med egenskapen DisplayName inställd på mySwitch och värdet Enabled inställt på true. I ditt .NET Framework-program kan du använda det konfigurerade växelvärdet genom att skapa en BooleanSwitch med samma namn, som du ser i följande kodexempel.

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

För .NET Core- och .NET 5+-appar är egenskapen Enabled för den nya växeln inställd på false som standard.

För .NET Framework-appar anges egenskapen Enabled med det värde som anges i konfigurationsfilen. Konfigurera växeln med värdet 0 för att ange Enabled egenskapen till false. Konfigurera växeln med ett värde som inte är noll för att ange Enabled egenskapen till true. BooleanSwitch Om konstruktorn inte kan hitta inledande växelinställningar i konfigurationsfilen är Enabled egenskapen för den nya växeln inställd på false.

Du måste aktivera spårning eller felsökning för att kunna använda en växel. Följande syntax är kompilatorspecifik. Om du använder andra kompilatorer än C# eller Visual Basic läser du dokumentationen för kompilatorn.

  • Om du vill aktivera felsökning i C# lägger du till /d:DEBUG flaggan på kommandoraden för kompilatorn när du kompilerar koden, eller så kan du lägga till #define DEBUG överst i filen. I Visual Basic lägger du till flaggan /d:DEBUG=True på kommandoraden för kompilatorn.

  • Om du vill aktivera spårning i C# lägger du till /d:TRACE flaggan på kommandoraden för kompilatorn när du kompilerar koden eller lägger till #define TRACE den överst i filen. I Visual Basic lägger du till flaggan /d:TRACE=True på kommandoraden för kompilatorn.

Note

Dessa felsöknings- och spårningskompilatorväxlar krävs inte när klassen används BooleanSwitch isolerat. De krävs endast tillsammans med Trace eller Debug metoder som är villkorligt kompilerade.

Mer information om hur du instrumenterar ditt program finns i Debug och Trace. Mer information om hur du konfigurerar och använder spårningsväxlar finns i Spårningsväxlar.

Note

För att förbättra prestandan kan du göra BooleanSwitch medlemmar static i din klass.

Konstruktorer

Name Description
BooleanSwitch(String, String, String)

Initierar en ny instans av BooleanSwitch klassen med det angivna visningsnamnet, beskrivningen och standardväxelvärdet.

BooleanSwitch(String, String)

Initierar en ny instans av BooleanSwitch klassen med det angivna visningsnamnet och beskrivningen.

Egenskaper

Name Description
Attributes

Hämtar de anpassade växelattribut som definierats i programkonfigurationsfilen.

(Ärvd från Switch)
Description

Hämtar en beskrivning av växeln.

(Ärvd från Switch)
DisplayName

Hämtar ett namn som används för att identifiera växeln.

(Ärvd från Switch)
Enabled

Hämtar eller anger ett värde som anger om växeln är aktiverad eller inaktiverad.

SwitchSetting

Hämtar eller anger den aktuella inställningen för den här växeln.

(Ärvd från Switch)
Value

Hämtar eller anger värdet för växeln.

(Ärvd från Switch)

Metoder

Name Description
Equals(Object)

Avgör om det angivna objektet är lika med det aktuella objektet.

(Ärvd från Object)
GetHashCode()

Fungerar som standard-hash-funktion.

(Ärvd från Object)
GetSupportedAttributes()

Hämtar de anpassade attribut som stöds av växeln.

(Ärvd från Switch)
GetType()

Hämtar den aktuella instansen Type .

(Ärvd från Object)
MemberwiseClone()

Skapar en ytlig kopia av den aktuella Object.

(Ärvd från Object)
OnSwitchSettingChanged()

Anropas när egenskapen SwitchSetting ändras.

(Ärvd från Switch)
OnValueChanged()

Avgör om det nya värdet för Value egenskapen kan parsas som ett booleskt värde.

ToString()

Returnerar en sträng som representerar det aktuella objektet.

(Ärvd från Object)

Gäller för

Se även