ConditionalAttribute ConditionalAttribute ConditionalAttribute ConditionalAttribute Class

Definition

Zeigt den Compilern an, dass ein Methodenaufruf oder ein Attribut ignoriert werden soll, wenn kein angegebenes bedingtes Kompilierungssymbol definiert ist.Indicates to compilers that a method call or attribute should be ignored unless a specified conditional compilation symbol is defined.

public ref class ConditionalAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
public sealed class ConditionalAttribute : Attribute
type ConditionalAttribute = class
    inherit Attribute
Public NotInheritable Class ConditionalAttribute
Inherits Attribute
Vererbung
ConditionalAttributeConditionalAttributeConditionalAttributeConditionalAttribute
Attribute

Beispiele

Das folgende Beispiel veranschaulicht die Verwendung von ConditionalAttribute.The following example demonstrates the use of ConditionalAttribute. Im Beispiel wird davon ausgegangen, dass die Bedingung mit der /define -Compileroption definiert ist.The example assumes that the condition is defined with the /define compiler option. Sie können unterschiedliche Ergebnisse abrufen, indem Sie die-Compileroption ändern.You can obtain different results by changing the compiler option. Sie können die Bedingungen optional mithilfe von Pragmas im Beispielcode definieren, anstatt Sie als Compileroptionen zu identifizieren.You can optionally define the conditions by using pragmas in the sample code instead of identifying them as compiler options.

#define CONDITION1
#define CONDITION2
using System;
using System.Diagnostics;

class Test
{
    static void Main()
    {               
        Console.WriteLine("Calling Method1");
        Method1(3);
        Console.WriteLine("Calling Method2");
        Method2();
        
        Console.WriteLine("Using the Debug class");
        Debug.Listeners.Add(new ConsoleTraceListener());
        Debug.WriteLine("DEBUG is defined");
    }
    
    [Conditional("CONDITION1")]
    public static void Method1(int x)
    {
        Console.WriteLine("CONDITION1 is defined");
    }
    
    [Conditional("CONDITION1"), Conditional("CONDITION2")]  
    public static void Method2()
    {
        Console.WriteLine("CONDITION1 or CONDITION2 is defined");
    }
}

/*
When compiled as shown, the application (named ConsoleApp) 
produces the following output.

Calling Method1
CONDITION1 is defined
Calling Method2
CONDITION1 or CONDITION2 is defined
Using the Debug class
DEBUG is defined
*/
#Const CONDITION1 = True
#Const CONDITION2 = True
Imports System.Diagnostics

Class Test

    Shared Sub Main()
        Console.WriteLine("Calling Method1")
        Method1(3)
        Console.WriteLine("Calling Method2")
        Method2()
        
        Console.WriteLine("Using the Debug class")
        Debug.Listeners.Add(New ConsoleTraceListener())
        Debug.WriteLine("DEBUG is defined")
    End Sub
       
    <ConditionalAttribute("CONDITION1")> _
    Shared Sub Method1(x As Integer)
        Console.WriteLine("CONDITION1 is defined")
    End Sub
    
    <ConditionalAttribute("CONDITION1"), ConditionalAttribute("CONDITION2")> _
    Shared Sub Method2()
        Console.WriteLine("CONDITION1 or CONDITIOIN2 is defined")
    End Sub
    
End Class


' When compiled as shown, the application (named ConsoleApp) 
' produces the following output.

'Calling Method1
'CONDITION1 is defined
'Calling Method2
'CONDITION1 or CONDITION2 is defined
'Using the Debug class
'DEBUG is defined

Hinweise

Sie können das ConditionalAttribute -Attribut auf Methoden und Klassen anwenden.You can apply the ConditionalAttribute attribute to methods and classes. Allerdings ist die Verwendung für Klassen nur für Typen gültig, die von Attributeabgeleitet sind.However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttributewird entweder ignoriert oder erzeugt eine Compilerwarnung oder eine Fehlermeldung, wenn Sie Sie auf einen anderen Typ anwenden.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

Durch ConditionalAttribute das Anwenden auf eine Methode ConditionalAttribute wird den Compilern angezeigt, dass ein Methodenaufrufe nicht in MSIL (Microsoft Intermediate Language) kompiliert werden dürfen, es sei denn, das bedingte Kompilierungs Symbol, das zugeordnet ist, ist definiert.Applying ConditionalAttribute to a method indicates to compilers that a call to the method should not be compiled into Microsoft intermediate language (MSIL) unless the conditional compilation symbol that is associated with ConditionalAttribute is defined. Sie erhalten einen Kompilierungsfehler in Visual Studio, wenn Sie dieses Attribut auf eine Methode anwenden, die nicht "void" zurückgibt.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. Die ConditionalAttribute Anwendung auf ein Attribut gibt an, dass das Attribut nicht an Metadaten ausgegeben werden soll, es sei denn, das bedingte Kompilierungs Symbol ist definiert.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Alle Argumente, die an die Methode oder das Attribut weitergegeben werden, werden vom Compiler immer noch vom Compiler geprüft.Any arguments passed to the method or attribute are still type-checked by the compiler.

Sie können die folgenden Verfahren verwenden, um Symbole für die bedingte Kompilierung zu definieren:You can use the following techniques to define conditional compilation symbols:

  • Compilerbefehlszeilenoptionen verwenden; Beispiel :/define: Debug.Use compiler command-line options; for example, /define:DEBUG.

  • Verwenden von Umgebungsvariablen in der Betriebssystemshell Legen Sie z. b. Debug = 1 fest.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Verwenden Sie Pragmas im Quellcode. definieren Sie z. b. die Kompilierungs Variable wie folgt:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Um die Variable zu definieren, verwenden Sie Folgendes:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Compiler, die die Common Language Specification (CLS) einhalten, dürfen ignorieren ConditionalAttribute.Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. Die C#-,-Visual Basic C++ -und- ConditionalAttributeCompiler unterstützen. der JScript-Compiler unterstützt das-Attribut nicht.The C#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Hinweis

In Visual Basic wird der AddressOf -Operator nicht von diesem Attribut beeinflusst.In Visual Basic, the AddressOf operator is not affected by this attribute. Beispielsweise Call CType(AddressOf delegate, Action) ruft delegateimmer auf, obwohl Call delegate() dies nicht möglich ist.For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttributewird auf die Methoden angewendet, die in der- Debug Klasse Trace und der-Klasse definiert sind.ConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Weitere Informationen zum Verwenden von Attributen finden Sie unter Attribute.For more information about how to use attributes, see Attributes.

Konstruktoren

ConditionalAttribute(String) ConditionalAttribute(String) ConditionalAttribute(String) ConditionalAttribute(String)

Initialisiert eine neue Instanz der ConditionalAttribute-Klasse.Initializes a new instance of the ConditionalAttribute class.

Eigenschaften

ConditionString ConditionString ConditionString ConditionString

Ruft das dem ConditionalAttribute-Attribut zugeordnete Symbol für die bedingte Kompilierung ab.Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methoden

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

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für: