ObsoleteAttribute Clase

Definición

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

Herencia

Object

Attribute

ObsoleteAttribute

Atributos

AttributeUsageAttribute SerializableAttribute ComVisibleAttribute

Ejemplos

En el ejemplo siguiente se define una clase que contiene una propiedad y un método marcados con el ObsoleteAttribute atributo.The following example defines a class that contains a property and a method that are marked with the ObsoleteAttribute attribute. El acceso al valor de la OldProperty propiedad en el código genera una advertencia del compilador, pero la llamada al CallOldMethod método genera un error del compilador.Accessing the value of the OldProperty property in code generates a compiler warning, but calling the CallOldMethod method generates a compiler error. En el ejemplo también se muestra el resultado que se obtiene al intentar compilar el código fuente.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())
'                            ~~~~~~~~~~~~~

Comentarios

ObsoleteAttribute es aplicable a todos los elementos de programa, excepto los ensamblados, los módulos, los parámetros y los valores devueltos.ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters, and return values. Al marcar un elemento como obsoleto, se informa a los usuarios de que el elemento puede quitarse en una versión futura del producto.Marking an element as obsolete informs users that the element may be removed in a future version of the product.

El compilador emite la cadena asignada a la Message propiedad cuando el destino del atributo se utiliza en el código.The string assigned to the Message property is emitted by the compiler when the attribute target is used in code. Idealmente, la cadena debe proporcionar alguna alternativa o alternativa mediante programación.Ideally, the string should provide some workaround or programmatic alternative.

Utilice la IsError propiedad para indicar al compilador si el uso del ObsoleteAttribute atributo debe hacer que emita un error ( IsError es true ) o una advertencia ( IsError es 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).

Para obtener más información sobre el uso de atributos, vea atributos.For more information about using attributes, see Attributes.

Aplicaciones de la tienda Windows 8. xWindows 8.x Store apps

Cuando se crea una biblioteca de metadatos de Windows (archivo. winmd), ObsoleteAttribute se exporta como el atributo ObsoleteAttribute y el atributo Windows. Foundation. Metadata. DeprecatedAttribute si solo ObsoleteAttribute está presente en el código fuente.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. El ObsoleteAttribute se transforma en de la DeprecatedAttribute manera siguiente:The ObsoleteAttribute is transformed to the DeprecatedAttribute as follows:

• Si los message error argumentos y están presentes, message se asigna al DeprecatedAttribute message argumento.If the message and error arguments are both present, message is assigned to the DeprecatedAttribute message argument. Un valor de error de true se asigna a DeprecationType. Removey un error valor de false se asigna a DeprecationType. deprecated.An error value of true maps to DeprecationType.Remove, and an error value of false maps to DeprecationType.Deprecate.

• Si el message argumento no se proporciona en ObsoleteAttribute , su valor predeterminado en DeprecatedAttribute es "element_name está en desuso", donde element_name es el nombre del elemento del programa de destino al que se aplica el atributo.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.

• Si el error argumento no está presente en ObsoleteAttribute , su valor predeterminado en DeprecatedAttribute es DeprecationType.Deprecate .If the error argument is not present in the ObsoleteAttribute, its default value in the DeprecatedAttribute is DeprecationType.Deprecate.

Constructores

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a

Consulte también

• Attribute
• Ampliación de los metadatos mediante atributosExtend metadata using attributes