ObsoleteAttribute ObsoleteAttribute ObsoleteAttribute ObsoleteAttribute Class

Definice

Označí prvky programu, které se již nepoužívají.Marks the program elements that are no longer in use. Tuto třídu nelze zdědit.This class cannot be inherited.

public ref class ObsoleteAttribute sealed : Attribute
[System.Runtime.InteropServices.ComVisible(true)]
[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
type ObsoleteAttribute = class
    inherit Attribute
Public NotInheritable Class ObsoleteAttribute
Inherits Attribute
Dědičnost
ObsoleteAttributeObsoleteAttributeObsoleteAttributeObsoleteAttribute
Atributy

Příklady

Následující příklad definuje třídu, která obsahuje vlastnost a metodu, která je označena ObsoleteAttribute atributem.The following example defines a class that contains a property and a method that are marked with the ObsoleteAttribute attribute. Přístup k hodnotě OldProperty vlastnosti v kódu vygeneruje upozornění kompilátoru, ale CallOldMethod volání metody vygeneruje chybu kompilátoru.Accessing the value of the OldProperty property in code generates a compiler warning, but calling the CallOldMethod method generates a compiler error. Příklad také ukazuje výstup, který je výsledkem pokusu o kompilaci zdrojového kódu.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())
'                            ~~~~~~~~~~~~~

Poznámky

ObsoleteAttributeplatí pro všechny prvky programu s výjimkou sestavení, modulů, parametrů a návratových hodnot.ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters, and return values. Označení elementu jako zastaralých informuje uživatele o tom, že se element v budoucích verzích produktu odebere.Marking an element as obsolete informs users that the element will be removed in future versions of the product.

ObsoleteAttribute Třída obsahuje dvě vlastnosti:The ObsoleteAttribute class includes two properties:

  • Message.Message. Řetězec přiřazený k Message vlastnosti je vygenerován kompilátorem, pokud je cíl atributu použit v kódu.The string assigned to the Message property is emitted by the compiler when the attribute target is used in code. Řetězec by měl poznamenat, že cíl atributu je zastaralý a pokud je to možné, poskytněte nějaké alternativní řešení nebo programovou alternativu.The string should note that the attribute target is obsolete and, if possible, provide some workaround or programmatic alternative.

  • IsError.IsError. Jedná se o logickou hodnotu, která určuje, jestli má kompilátor ObsoleteAttribute použít atribut, aby vygeneroval chybu (IsError is true) nebo upozornění (IsError je false).This is a Boolean value that indicates to the compiler whether using the ObsoleteAttribute attribute should cause it to emit an error (IsError is true) or a warning (IsError is false).

Další informace o použití atributů naleznete v tématu Attributes.For more information about using attributes, see Attributes.

Windows 8.x StoreWindows 8.x StoreMůžouApps

ObsoleteAttribute Když vytváříte knihovnu metadat systému Windows (soubor. winmd), je exportována jako ObsoleteAttribute atribut i atribut Windows. Foundation. Metadata ObsoleteAttribute . DeprecatedAttribute, pokud je ve zdrojovém kódu přítomen pouze kód.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. Je transformována DeprecatedAttributenásledujícímzpůsobem: ObsoleteAttributeThe ObsoleteAttribute is transformed to the DeprecatedAttribute as follows:

  • error message DeprecatedAttribute Pokudargumentymessage a jsou oba přítomny, jsou přiřazeny k argumentu. messageIf the message and error arguments are both present, message is assigned to the DeprecatedAttribute message argument. Hodnota true chyby mapování na DeprecationType. Remove error false a hodnota map na DeprecationType.An error value of true maps to DeprecationType.Remove, and an error value of false maps to DeprecationType.Deprecate.

  • ObsoleteAttribute DeprecatedAttribute Není-li** ** argument zadán v, je jeho výchozí hodnota v atributu "element_name je zastaralá", kde element_name je název elementu cílového programu, pro který je atribut použit. messageIf 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.

  • Pokud argument není přítomen ObsoleteAttributev, DeprecatedAttribute je jeho výchozí hodnota v DeprecationType. errorIf the error argument is not present in the ObsoleteAttribute, its default value in the DeprecatedAttribute is DeprecationType.Deprecate.

Důležité

Přímé Aplikování atributu Windows. Foundation. Metadata. DeprecatedAttribute na spravovaný kód se nedoporučuje, protože tento export probíhá automaticky.Directly applying the Windows.Foundation.Metadata.DeprecatedAttribute attribute to managed code is not recommended, because this export occurs automatically.

Konstruktory

ObsoleteAttribute() ObsoleteAttribute() ObsoleteAttribute() ObsoleteAttribute()

Inicializuje novou instanci ObsoleteAttribute třídy s výchozími vlastnostmi.Initializes a new instance of the ObsoleteAttribute class with default properties.

ObsoleteAttribute(String) ObsoleteAttribute(String) ObsoleteAttribute(String) ObsoleteAttribute(String)

Inicializuje novou instanci ObsoleteAttribute třídy se zadanou zprávou s alternativním řešením.Initializes a new instance of the ObsoleteAttribute class with a specified workaround message.

ObsoleteAttribute(String, Boolean) ObsoleteAttribute(String, Boolean) ObsoleteAttribute(String, Boolean) ObsoleteAttribute(String, Boolean)

Inicializuje novou instanci ObsoleteAttribute třídy se zprávou o alternativním problému a logickou hodnotou, která označuje, zda je použití zastaralého prvku považováno za chybu.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.

Vlastnosti

IsError IsError IsError IsError

Získá logickou hodnotu, která označuje, zda bude kompilátor považovat použití zastaralého prvku programu za chybu.Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.

Message Message Message Message

Získá zprávu alternativního řešení, včetně popisu alternativních prvků programu.Gets the workaround message, including a description of the alternative program elements.

TypeId TypeId TypeId TypeId

Při implementaci v odvozené třídě získá jedinečný identifikátor Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Metody

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

Vrací hodnotu, která určuje, zda je tato instance rovna zadanému objektu.Returns a value that indicates whether this instance is equal to a specified object.

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

Vrátí kód hash této instance.Returns the hash code for this instance.

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

Type Získá aktuální instanci.Gets the Type of the current instance.

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

Při přepsání v odvozené třídě označuje, zda je hodnota této instance výchozí hodnotou pro odvozenou třídu.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)

Při přepsání v odvozené třídě vrátí hodnotu, která označuje, zda je tato instance rovna zadanému objektu.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()

Vytvoří kopii aktuálního Objectseznamu.Creates a shallow copy of the current Object.

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

Vrací řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Inherited from Object)

Explicitní implementace rozhraní

_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)

Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání.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)

Načte informace o typu pro objekt, který lze použít k získání informací o typu pro rozhraní.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)

Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 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)

Poskytuje přístup k vlastnostem a metodám vystaveným objektem.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Platí pro

Viz také