ObsoleteAttribute Klasse

Definition

Markiert die Programmelemente, die nicht mehr verwendet werden. Diese Klasse kann nicht vererbt werden.

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)]
[System.Serializable]
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)]
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
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
[<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)>]
[<System.Serializable>]
type ObsoleteAttribute = class
    inherit 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)>]
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ObsoleteAttribute = class
    inherit Attribute
Public NotInheritable Class ObsoleteAttribute
Inherits Attribute
Vererbung
ObsoleteAttribute
Attribute

Beispiele

Im folgenden Beispiel wird eine Klasse definiert, die eine Eigenschaft und eine Methode enthält, die mit dem ObsoleteAttribute Attribut gekennzeichnet ist. Der Zugriff auf den Wert der Eigenschaft im Code generiert eine Compilerwarnung, aber beim Aufrufen der OldProperty CallOldMethod Methode wird ein Compilerfehler generiert. Im Beispiel wird auch die Ausgabe angezeigt, die beim Versuch, den Quellcode zu kompilieren.

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())
'                            ~~~~~~~~~~~~~

Hinweise

ObsoleteAttribute gilt für alle Programmelemente mit Ausnahme von Assemblys, Modulen, Parametern und Rückgabewerten. Das Markieren eines Elements als veraltet informiert Benutzer, dass das Element in einer zukünftigen Version des Produkts entfernt werden kann.

Die Zeichenfolge, die der Message Eigenschaft zugewiesen ist, wird vom Compiler ausgegeben, wenn das Attributziel im Code verwendet wird. Idealerweise sollte die Zeichenfolge eine Problemumgehung oder programmgesteuerte Alternative bereitstellen.

Verwenden Sie die Eigenschaft, um anzugeben, ob die IsError Verwendung des ObsoleteAttribute Attributs zu einem Fehler ( ist ) oder einer WarnungIsError (IsErroristtrue``false) führen soll .

Weitere Informationen zur Verwendung von Attributen finden Sie unter Attribute.

Windows 8.x Store Apps

Wenn Sie eine Windows Metadatenbibliothek (Winmd-Datei) erstellen, wird die ObsoleteAttribute ObsoleteAttribute Datei sowohl als Attribut als auch als Windows exportiert. Foundation.Metadata.DeprecatedAttribute-Attribut, wenn nur der ObsoleteAttribute Quellcode vorhanden ist. Die ObsoleteAttribute Transformation erfolgt wie DeprecatedAttribute folgt:

  • Wenn beide message error Argumente vorhanden sind, message wird dem DeprecatedAttribute message Argument zugewiesen. Ein Fehlerwert von Karten zu "DeprecationType.Remove" und ein error Wert von true false Karten zu "DeprecationType.Deprecate".

  • Wenn das message Argument nicht in der ObsoleteAttributeDeprecatedAttribute Angabe angegeben wird, ist der Standardwert im Wert "element_name ist veraltet", wobei element_name der Name des Zielprogrammelements ist, auf das das Attribut angewendet wird.

  • Wenn das error Argument nicht im Wert vorhanden ist, ist der Standardwert in der DeprecatedAttribute ObsoleteAttributeDeprecationType.DeprecateDatei ".

Wichtig

Direkt anwenden des Windows. Foundation.Metadata.DeprecatedAttribute-Attribut für verwalteten Code wird nicht empfohlen, da dieser Export automatisch auftritt.

Konstruktoren

ObsoleteAttribute()

Initialisiert eine neue Instanz der ObsoleteAttribute-Klasse mit Standardeigenschaften.

ObsoleteAttribute(String)

Initialisiert eine neue Instanz der ObsoleteAttribute-Klasse mit einer angegebenen Meldung zur Problemumgehung.

ObsoleteAttribute(String, Boolean)

Initialisiert eine neue Instanz der ObsoleteAttribute-Klasse mit einer Meldung über Umgehungsmöglichkeiten und einem booleschen Wert, der angibt, ob die Verwendung des veralteten Elements als Fehler zu behandeln ist.

Eigenschaften

DiagnosticId

Ruft die ID ab, die der Compiler verwendet, wenn eine Verwendung der API gemeldet wird, oder legt sie fest.

IsError

Ruft einen Wert ab, der angibt, ob der Compiler die Verwendung des veralteten Programmelements als Fehler behandelt.

Message

Ruft die Problemumgehungsmeldung ab.

TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.

(Geerbt von Attribute)
UrlFormat

Ruft die URL für die entsprechende Dokumentation ab oder legt sie fest. Die API akzeptiert eine Formatzeichenfolge anstelle einer tatsächlichen URL und erstellt eine generische URL, die die Diagnose-ID enthält.

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.

(Geerbt von Attribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.

(Geerbt von Attribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.

(Geerbt von Attribute)
_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.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.

(Geerbt von Attribute)

Gilt für:

Siehe auch