ObsoleteAttribute Sınıf

Tanım

Ad Alanı:

System

Bütünleştirilmiş Kod:

System.Runtime.dll

Kaynak:

ObsoleteAttribute.cs

Artık kullanımda olmayan program öğelerini işaretler. Bu sınıf devralınamaz.

public ref class ObsoleteAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct, Inherited=false)]
public sealed class ObsoleteAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Constructor | System.AttributeTargets.Delegate | System.AttributeTargets.Enum | System.AttributeTargets.Event | System.AttributeTargets.Field | System.AttributeTargets.Interface | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Struct, Inherited=false)>]
type ObsoleteAttribute = class
    inherit Attribute

Public NotInheritable Class ObsoleteAttribute
Inherits Attribute

Devralma

Object

Attribute

ObsoleteAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki örnek, özelliği ve özniteliğiyle ObsoleteAttribute işaretlenmiş bir yöntemi içeren bir sınıfı tanımlar. Koddaki özelliğin OldProperty değerine erişmek bir derleyici uyarısı oluşturur, ancak yöntemini çağırmak CallOldMethod derleyici hatası oluşturur. Örnekte, kaynak kodu derlemeye çalıştığınızda elde ettiğiniz çıkış da gösterilir.

using System;
using System.Reflection;

public class Example
{
   // Mark OldProperty As Obsolete.
   [ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", false)]
   public static string OldProperty
   { get { return "The old property value."; } }

   public static string NewProperty
   { get { return "The new property value."; } }

   // Mark CallOldMethod As Obsolete.
   [ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", true)]
   public static string CallOldMethod()
   {
      return "You have called CallOldMethod.";
   }

   public static string CallNewMethod()
   {
      return "You have called CallNewMethod.";
   }

   public static void Main()
   {
      Console.WriteLine(OldProperty);
      Console.WriteLine();
      Console.WriteLine(CallOldMethod());
   }
}
// The attempt to compile this example produces output like the following output:
//    Example.cs(31,25): error CS0619: 'Example.CallOldMethod()' is obsolete:
//            'This method is obsolete. Call CallNewMethod instead.'
//    Example.cs(29,25): warning CS0618: 'Example.OldProperty' is obsolete:
//            'This property is obsolete. Use NewProperty instead.'

open System

// Mark oldValue As Obsolete.
[<ObsoleteAttribute("This value is obsolete. Use newValue instead.", false)>]
let oldValue =
    "The old property value."

let newValue =
    "The new property value."

// Mark callOldFunction As Obsolete.
[<ObsoleteAttribute("This function is obsolete. Call callNewFunction instead.", true)>]
let callOldFunction () =
    "You have called CallOldMethod."

let callNewFunction () =
    "You have called CallNewMethod."

printfn $"{oldValue}"
printfn ""
printfn $"{callOldFunction ()}"
// The attempt to compile this example produces output like the following output:
//    Example.fs(23,12): error FS0101: This construct is deprecated. This function is obsolete. Call callNewFunction instead.
//    Example.fs(21,12): warning FS0044: This construct is deprecated. This value is obsolete. Use newValue instead.

Imports System.Reflection

Public Module Example
   ' Mark OldProperty As Obsolete.
   <ObsoleteAttribute("This property is obsolete. Use NewProperty instead.", False)> 
   Public ReadOnly Property OldProperty As String
      Get
         Return "The old property value."
      End Get
   End Property
   
   Public ReadOnly Property NewProperty As String
      Get
         Return "The new property value."
      End Get
   End Property
   
   ' Mark OldMethod As Obsolete.
   <ObsoleteAttribute("This method is obsolete. Call CallNewMethod instead.", True)> 
   Public Function CallOldMethod() As String
      Return "You have called CallOldMethod."
   End Function
      
   Public Function CallNewMethod() As String   
      Return "You have called NewMethod."
   End Function   
   
   Public Sub Main()
      Console.WriteLine(OldProperty)
      Console.WriteLine()
      Console.WriteLine(CallOldMethod())
   End Sub  
End Module
'  The attempt to compile this example produces output like the following:
'    Example.vb(30) : warning BC40000: 'Public ReadOnly Property OldProperty As String' is obsolete: 
'                     'This property is obsolete. Use NewProperty instead.'.
'    
'          Console.WriteLine(OldProperty)
'                            ~~~~~~~~~~~
'    Example.vb(32) : error BC30668: 'Public Function CallOldMethod() As String' is obsolete: 
'                     'This method is obsolete. Call CallNewMethod instead.'.
'    
'          Console.WriteLine(CallOldMethod())
'                            ~~~~~~~~~~~~~

Açıklamalar

ObsoleteAttribute derlemeler, modüller, parametreler ve dönüş değerleri dışındaki tüm program öğeleri için geçerlidir. Bir öğeyi eski olarak işaretlemek, kullanıcılara öğenin ürünün gelecekteki bir sürümünde kaldırılabileceğini bildirir.

Özelliğe atanan Message dize, kodda öznitelik hedefi kullanıldığında derleyici tarafından yayılır. İdeal olarak, dizenin geçici bir çözüm veya program aracılığıyla alternatif sağlaması gerekir.

özniteliğini IsError kullanmanın ObsoleteAttribute hata ( is true) veya uyarı (IsErrorIsError is false) yaymasına neden olup olmayacağını derleyiciye göstermek için özelliğini kullanın.

Öznitelikleri kullanma hakkında daha fazla bilgi için bkz . Öznitelikler.

Oluşturucular

ObsoleteAttribute()	Sınıfın ObsoleteAttribute yeni bir örneğini varsayılan özelliklerle başlatır.
ObsoleteAttribute(String)	Belirtilen geçici çözüm iletisiyle sınıfının yeni bir örneğini ObsoleteAttribute başlatır.
ObsoleteAttribute(String, Boolean)	Sınıfın ObsoleteAttribute yeni bir örneğini geçici bir çözüm iletisiyle ve eski öğe kullanımının hata olarak kabul edilip edilmediğini belirten bir Boole değeriyle başlatır.

Özellikler

DiagnosticId	API kullanımını bildirirken derleyicinin kullanacağı kimliği alır veya ayarlar.
IsError	Derleyicinin eski program öğesinin kullanımını hata olarak değerlendirip değerlendirmediğini belirten bir değer alır.
Message	Geçici çözüm iletisini alır.
TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)
UrlFormat	İlgili belgelerin URL'sini alır veya ayarlar. API, gerçek URL yerine bir biçim dizesi kabul eder ve tanılama kimliğini içeren genel bir URL oluşturur.

Yöntemler

Equals(Object)	Bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değeri döndürür. (Devralındığı yer: Attribute)
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür. (Devralındığı yer: Attribute)
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)

Ayrıca bkz.

• Attribute
• Öznitelikleri kullanarak meta verileri genişletme