ConditionalAttribute Sınıf

Tanım

Belirtilen koşullu derleme sembolü tanımlanmadığı takdirde bir yöntem çağrısının veya özniteliğin yoksayılması gerektiğini derleyiciler olarak gösterir.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)]
public sealed class ConditionalAttribute : Attribute
public sealed class ConditionalAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
public sealed class ConditionalAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ConditionalAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)>]
type ConditionalAttribute = class
    inherit Attribute
type ConditionalAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=true)>]
[<System.Serializable>]
type ConditionalAttribute = class
    inherit Attribute
[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true)>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ConditionalAttribute = class
    inherit Attribute
Public NotInheritable Class ConditionalAttribute
Inherits Attribute
Devralma
ConditionalAttribute
Öznitelikler

Örnekler

Aşağıdaki örnek öğesinin kullanımını gösterir ConditionalAttribute .The following example demonstrates the use of ConditionalAttribute. Örnek, koşulun /define derleyici seçeneği ile tanımlandığını varsayar.The example assumes that the condition is defined with the /define compiler option. Derleyici seçeneğini değiştirerek farklı sonuçlar elde edebilirsiniz.You can obtain different results by changing the compiler option. İsteğe bağlı olarak, örnekleri derleyici seçenekleri olarak tanımlamak yerine örnek kodda pragmalar kullanarak tanımlayabilirsiniz.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

Açıklamalar

ConditionalAttributeÖzniteliği yöntemlere ve sınıflara uygulayabilirsiniz.You can apply the ConditionalAttribute attribute to methods and classes. Ancak, sınıfları üzerinde kullanımı yalnızca öğesinden türetilmiş türler için geçerlidir Attribute .However, its use on classes is valid only for types that are derived from Attribute. ConditionalAttribute yok sayılacak ya da başka bir türe uygularsanız bir derleyici uyarısı veya hata iletisi üretecektir.ConditionalAttribute either will be ignored or will produce a compiler warning or error message if you apply it to any other type.

ConditionalAttributeBir yönteme uygulamak, ile ilişkili koşullu derleme sembolü tanımlanmadığı takdirde, metoda yapılan bir çağrının Microsoft ara dil 'e (MSIL) derlenmemelidir ConditionalAttribute .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. Bu özniteliği, void döndürmeyen bir yönteme uygularsanız, Visual Studio 'da derleme hatası alırsınız.You will get a compilation error in Visual Studio if you apply this attribute to a method that does not return void. ConditionalAttributeBir özniteliğe uygulamak, koşullu derleme sembolü tanımlanmadığı müddetçe özniteliğin meta veriye yayılmayacağını gösterir.Applying ConditionalAttribute to an attribute indicates that the attribute should not be emitted to metadata unless the conditional compilation symbol is defined. Yönteme veya özniteliğe geçirilen bağımsız değişkenler, derleyici tarafından hala tür denetimli olarak denetlenir.Any arguments passed to the method or attribute are still type-checked by the compiler.

Koşullu derleme sembolleri tanımlamak için aşağıdaki teknikleri kullanabilirsiniz:You can use the following techniques to define conditional compilation symbols:

  • Derleyici komut satırı seçeneklerini kullanın; Örneğin, /define: Debug.Use compiler command-line options; for example, /define:DEBUG.

  • İşletim sistemi kabuğu 'nda ortam değişkenlerini kullanın; Örneğin, hata ayıklama = 1' i ayarlayın.Use environment variables in the operating system shell; for example, set DEBUG=1.

  • Kaynak kodda pragmalar kullanın; Örneğin, derleme değişkenini aşağıdaki gibi tanımlayın:Use pragmas in the source code; for example, define the compilation variable as follows:

    #define DEBUG  
    
    #Const DEBUG=True  
    

    Değişkeni tanımlamak için aşağıdakileri kullanın:To undefine the variable, use the following:

    #undef DEBUG  
    
    #Const DEBUG=False  
    

Ortak dil belirtimi (CLS) ile uyumlu olan derleyicilerin yoksaymasına izin verilir ConditionalAttribute .Compilers that comply with the Common Language Specification (CLS) are permitted to ignore ConditionalAttribute. C#, F #, Visual Basic ve C++ derleyicileri desteği ConditionalAttribute ; JScript derleyicisi özniteliği desteklemez.The C#, F#, Visual Basic, and C++ compilers support ConditionalAttribute; the JScript compiler does not support the attribute.

Not

Visual Basic, AddressOf işleç bu öznitelikten etkilenmez.In Visual Basic, the AddressOf operator is not affected by this attribute. Örneğin, Call CType(AddressOf delegate, Action) her zaman çağırır delegate , ancak çalışmayabilir Call delegate() .For example, Call CType(AddressOf delegate, Action) always invokes delegate, although Call delegate() might not.

ConditionalAttribute , ve sınıflarında tanımlanan yöntemlere uygulanır Debug Trace .ConditionalAttribute is applied to the methods that are defined in the Debug and Trace classes.

Öznitelikleri kullanma hakkında daha fazla bilgi için bkz. öznitelikler.For more information about how to use attributes, see Attributes.

Oluşturucular

ConditionalAttribute(String)

ConditionalAttribute sınıfının yeni bir örneğini başlatır.Initializes a new instance of the ConditionalAttribute class.

Özellikler

ConditionString

Özniteliğiyle ilişkili koşullu derleme sembolünü alır ConditionalAttribute .Gets the conditional compilation symbol that is associated with the ConditionalAttribute attribute.

TypeId

Türetilmiş bir sınıfta uygulandığında, bunun için benzersiz bir tanımlayıcı alır Attribute .When implemented in a derived class, gets a unique identifier for this Attribute.

(Devralındığı yer: Attribute)

Yöntemler

Equals(Object)

Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür.Returns a value that indicates whether this instance is equal to a specified object.

(Devralındığı yer: Attribute)
GetHashCode()

Bu örneğe ilişkin karma kodu döndürür.Returns the hash code for this instance.

(Devralındığı yer: Attribute)
GetType()

TypeGeçerli örneği alır.Gets the Type of the current instance.

(Devralındığı yer: Object)
IsDefaultAttribute()

Türetilmiş bir sınıfta geçersiz kılınırsa, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Devralındığı yer: Attribute)
Match(Object)

Türetilmiş bir sınıfta geçersiz kılınırsa, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Devralındığı yer: Attribute)
MemberwiseClone()

Geçerli bir basit kopyasını oluşturur Object .Creates a shallow copy of the current Object.

(Devralındığı yer: Object)
ToString()

Geçerli nesneyi temsil eden dizeyi döndürür.Returns a string that represents the current object.

(Devralındığı yer: Object)

Belirtik Arabirim Kullanımları

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

Bir ad kümesini karşılık gelen bir dağıtma tanımlayıcısı kümesine eşler.Maps a set of names to a corresponding set of dispatch identifiers.

(Devralındığı yer: Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Bir arabirimin tür bilgilerini almak için kullanılabilen bir nesnenin tür bilgilerini alır.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Devralındığı yer: Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Bir nesnenin sağladığı tür bilgisi arabirimlerinin sayısını alır (0 ya da 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Devralındığı yer: Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Bir nesne tarafından sunulan özelliklere ve yöntemlere erişim sağlar.Provides access to properties and methods exposed by an object.

(Devralındığı yer: Attribute)

Şunlara uygulanır