AppContext.TryGetSwitch(String, Boolean) Metoda

Definice

Obor názvů:

System

Sestavení:

System.Runtime.dll

Zdroj:

AppContext.cs

Pokusí se získat hodnotu přepínače.

public:
 static bool TryGetSwitch(System::String ^ switchName, [Runtime::InteropServices::Out] bool % isEnabled);

public static bool TryGetSwitch (string switchName, out bool isEnabled);

static member TryGetSwitch : string * bool -> bool

Public Shared Function TryGetSwitch (switchName As String, ByRef isEnabled As Boolean) As Boolean

Parametry

switchName

String

Název přepínače

isEnabled

Boolean

Když tato metoda vrátí, obsahuje hodnotu , switchName pokud switchName byl nalezen, nebo false pokud switchName nebyl nalezen. Tento parametr se předává neinicializovaný.

Návraty

Boolean

true pokud switchName byl nastaven a isEnabled argument obsahuje hodnotu přepínače, falsejinak hodnota .

Výjimky

ArgumentNullException

switchName je null.

ArgumentException

switchName je Empty.

Příklady

Následující příklad určuje, jestli uživatel knihovny nastavil přepínač s názvem Switch.AmazingLib.ThrowOnException.

public class AmazingLib
{
   private bool shouldThrow;

   public void PerformAnOperation()
   {
      if (!AppContext.TryGetSwitch("Switch.AmazingLib.ThrowOnException", out shouldThrow)) {
         // This is the case where the switch value was not set by the application.
         // The library can choose to get the value of shouldThrow by other means.
         // If no overrides or default values are specified, the value should be 'false'.
         // A false value implies the latest behavior.
      }

      // The library can use the value of shouldThrow to throw exceptions or not.
      if (shouldThrow) {
         // old code
      }
      else {
          // new code
      }
   }
}

module AmazingLib =
    let performAnOperation () =
        match AppContext.TryGetSwitch "Switch.AmazingLib.ThrowOnException" with
        | false, _ ->
            // This is the case where the switch value was not set by the application.
            // The library can choose to get the value of shouldThrow by other means.
            // If no overrides or default values are specified, the value should be 'false'.
            // A false value implies the latest behavior.
            ()
        | true, shouldThrow ->
            // The library can use the value of shouldThrow to throw exceptions or not.
            if shouldThrow then
                // old code
                ()
            else
                // new code
                ()

Public Class AmazingLib

   Private shouldThrow As Boolean

   Public Sub PerformAnOperation()
      If Not AppContext.TryGetSwitch("Switch.AmazingLib.ThrowOnException", shouldThrow) Then 
         ' This is the case where the switch value was not set by the application. 
         ' The library can choose to get the value of shouldThrow by other means. 
         ' If no overrides or default values are specified, the value should be 'false'. 
         ' A false value implies the latest behavior.
      End If

      ' The library can use the value of shouldThrow to throw exceptions or not.
      If shouldThrow Then
         ' old code
      Else 
          ' new code
      End If
   End Sub
End Class

Poznámky

Třída AppContext umožňuje zapisovačům knihoven poskytovat uživatelům jednotný mechanismus odhlášení nových funkcí. Vytváří volně vázanou smlouvu mezi komponentami za účelem sdělení žádosti o vyjádření výslovného nesouhlasu. Tato funkce je obvykle důležitá, když se provede změna stávajících funkcí. Naopak už existuje implicitní výslovný souhlas s novými funkcemi.

Modul CLR (Common Language Runtime) automaticky naplní přepínače přiřazené k AppContext instanci čtením registru a konfiguračního souboru aplikace. Hodnotu těchto přepínačů lze potom přepsat a přidat nové přepínače voláním SetSwitch metody .

Knihovna volá metodu TryGetSwitch ke kontrole, zda její příjemci deklarovali hodnotu přepínače, a pak na ni odpovídajícím způsobem zareagujte. Pokud přepínač není definovaný, jsou ve výchozím nastavení povoleny nové funkce. Pokud je přepínač definovaný a jeho hodnota je false, jsou také povoleny nové funkce. Pokud je truejeho hodnota , starší verze chování je povolena.

Viz také

• SetSwitch(String, Boolean)