ObsoleteAttribute Klasa

Definicja

Oznacza elementy programu, które nie są już używane.Marks the program elements that are no longer in use. Klasa ta nie może być dziedziczona.This class cannot be inherited.

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
Dziedziczenie
ObsoleteAttribute
Atrybuty

Przykłady

W poniższym przykładzie zdefiniowano klasę, która zawiera właściwość i metodę, która jest oznaczona za pomocą ObsoleteAttribute atrybutu.The following example defines a class that contains a property and a method that are marked with the ObsoleteAttribute attribute. Uzyskanie dostępu do wartości OldProperty właściwości w kodzie powoduje wygenerowanie ostrzeżenia kompilatora, ale wywołanie CallOldMethod metody generuje błąd kompilatora.Accessing the value of the OldProperty property in code generates a compiler warning, but calling the CallOldMethod method generates a compiler error. W przykładzie pokazano również dane wyjściowe, które są wynikiem próby skompilowania kodu źródłowego.The example also shows the output that results when you attempt to compile the source code.

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

Uwagi

ObsoleteAttribute ma zastosowanie do wszystkich elementów programu z wyjątkiem zestawów, modułów, parametrów i zwracanych wartości.ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters, and return values. Oznaczenie elementu jako przestarzałego informuje użytkowników, że element może zostać usunięty w przyszłych wersjach produktu.Marking an element as obsolete informs users that the element may be removed in a future version of the product.

Ciąg przypisany do Message właściwości jest emitowany przez kompilator, gdy element docelowy atrybutu jest używany w kodzie.The string assigned to the Message property is emitted by the compiler when the attribute target is used in code. W idealnym przypadku ciąg powinien zapewnić pewne obejście lub programistyczną alternatywę.Ideally, the string should provide some workaround or programmatic alternative.

Użyj IsError właściwości, aby wskazać kompilatorowi, czy użycie ObsoleteAttribute atrybutu powinno spowodować wygenerowanie błędu ( IsError is true ) lub ostrzeżenia ( IsError is false ).Use the IsError property to indicate to the compiler whether using the ObsoleteAttribute attribute should cause it to emit an error (IsError is true) or a warning (IsError is false).

Aby uzyskać więcej informacji o korzystaniu z atrybutów, zobacz atrybuty.For more information about using attributes, see Attributes.

Aplikacje ze sklepu Windows 8. xWindows 8.x Store apps

Podczas tworzenia biblioteki metadanych systemu Windows (plik. winmd), ObsoleteAttribute jest eksportowany zarówno jako atrybut, jak ObsoleteAttribute i atrybut Windows. Foundation. Metadata. DeprecatedAttribute , jeśli występuje tylko ObsoleteAttribute w kodzie źródłowym.When you create a Windows Metadata library (.winmd file), the ObsoleteAttribute is exported as both the ObsoleteAttribute attribute and the Windows.Foundation.Metadata.DeprecatedAttribute attribute if only the ObsoleteAttribute is present in source code. ObsoleteAttributeJest przekształcony w DeprecatedAttribute następujący sposób:The ObsoleteAttribute is transformed to the DeprecatedAttribute as follows:

  • Jeśli message error oba argumenty i są obecne, message są przypisywane do DeprecatedAttribute message argumentu.If the message and error arguments are both present, message is assigned to the DeprecatedAttribute message argument. Wartość błędu true map do DeprecationType. Removei error wartość false mapy do DeprecationType. przestarzałe.An error value of true maps to DeprecationType.Remove, and an error value of false maps to DeprecationType.Deprecate.

  • Jeśli message argument nie jest podany w ObsoleteAttribute , jego wartość domyślna w DeprecatedAttribute elemencie is "element_name jest przestarzała", gdzie element_name jest nazwą elementu programu docelowego, do którego zastosowano atrybut.If the message argument is not supplied in the ObsoleteAttribute, its default value in the DeprecatedAttribute is "element_name is deprecated", where element_name is the name of the target program element to which the attribute is applied.

  • Jeśli error argument nie występuje w ObsoleteAttribute , jego wartość domyślna DeprecatedAttribute to DeprecationType.Deprecate .If the error argument is not present in the ObsoleteAttribute, its default value in the DeprecatedAttribute is DeprecationType.Deprecate.

Ważne

Nie zaleca się bezpośredniego stosowania atrybutu Windows. Foundation. Metadata. DeprecatedAttribute do kodu zarządzanego, ponieważ ten eksport odbywa się automatycznie.Directly applying the Windows.Foundation.Metadata.DeprecatedAttribute attribute to managed code is not recommended, because this export occurs automatically.

Konstruktory

ObsoleteAttribute()

Inicjuje nowe wystąpienie ObsoleteAttribute klasy z właściwościami domyślnymi.Initializes a new instance of the ObsoleteAttribute class with default properties.

ObsoleteAttribute(String)

Inicjuje nowe wystąpienie ObsoleteAttribute klasy z określonym komunikatem obejścia.Initializes a new instance of the ObsoleteAttribute class with a specified workaround message.

ObsoleteAttribute(String, Boolean)

Inicjuje nowe wystąpienie ObsoleteAttribute klasy za pomocą komunikatu obejścia i wartości logicznej wskazującej, czy przestarzałe użycie elementu jest uznawane za błąd.Initializes a new instance of the ObsoleteAttribute class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.

Właściwości

DiagnosticId

Pobiera lub ustawia identyfikator, który będzie używany przez kompilator podczas raportowania użycia interfejsu API.Gets or sets the ID that the compiler will use when reporting a use of the API.

IsError

Pobiera wartość wskazującą, czy kompilator będzie traktować użycie przestarzałego elementu programu jako błąd.Gets a value that indicates whether the compiler will treat usage of the obsolete program element as an error.

Message

Pobiera komunikat obejścia.Gets the workaround message.

TypeId

Po zaimplementowaniu w klasie pochodnej pobiera unikatowy identyfikator dla tego elementu Attribute .When implemented in a derived class, gets a unique identifier for this Attribute.

(Odziedziczone po Attribute)
UrlFormat

Pobiera lub ustawia adres URL odpowiedniej dokumentacji.Gets or sets the URL for corresponding documentation. Interfejs API akceptuje ciąg formatu zamiast rzeczywistego adresu URL, tworząc ogólny adres URL, który zawiera identyfikator diagnostyki.The API accepts a format string instead of an actual URL, creating a generic URL that includes the diagnostic ID.

Metody

Equals(Object)

Zwraca wartość wskazującą, czy to wystąpienie jest równe podanemu obiektowi.Returns a value that indicates whether this instance is equal to a specified object.

(Odziedziczone po Attribute)
GetHashCode()

Zwraca wartość skrótu dla tego wystąpienia.Returns the hash code for this instance.

(Odziedziczone po Attribute)
GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
IsDefaultAttribute()

Gdy jest zastępowany w klasie pochodnej, wskazuje, czy wartość tego wystąpienia jest wartością domyślną klasy pochodnej.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Odziedziczone po Attribute)
Match(Object)

Gdy jest zastępowany w klasie pochodnej, zwraca wartość wskazującą, czy to wystąpienie jest zgodne z określonym obiektem.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Odziedziczone po Attribute)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Jawne implementacje interfejsu

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

Zestaw nazw jest mapowany na odpowiedni zestaw identyfikatorów wysyłania.Maps a set of names to a corresponding set of dispatch identifiers.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Pobiera informacje o typie dla obiektu, którego można użyć do uzyskania informacji o typie dla interfejsu.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Odziedziczone po Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Pobiera informację o liczbie typów interfejsów, jakie zawiera obiekt (0 lub 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Odziedziczone po Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Umożliwia dostęp do właściwości i metod udostępnianych przez obiekt.Provides access to properties and methods exposed by an object.

(Odziedziczone po Attribute)

Dotyczy

Zobacz też