ObsoleteAttribute Class
Marks the program elements that are no longer in use. This class cannot be inherited.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
[SerializableAttribute] [AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Constructor|AttributeTargets.Method|AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Event|AttributeTargets.Interface|AttributeTargets.Delegate, Inherited = false)] [ComVisibleAttribute(true)] public sealed class ObsoleteAttribute : Attribute
The ObsoleteAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
   | ObsoleteAttribute() | Initializes a new instance of the ObsoleteAttribute class with default properties. |
| ObsoleteAttribute(String) | Initializes a new instance of the ObsoleteAttribute class with a specified workaround message. |
| ObsoleteAttribute(String, Boolean) | 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. |
| Name | Description | |
|---|---|---|
| IsError | Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error. |
| Message | Gets the workaround message, including a description of the alternative program elements. |
| TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| Name | Description | |
|---|---|---|
| Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
| GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsDefaultAttribute | 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 | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
| _Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
| _Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
| _Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
| _Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
ObsoleteAttribute is applicable to all program elements except assemblies, modules, parameters or return values. Marking an element as obsolete informs the users that the element will be removed in future versions of the product.
For more information about using attributes, see Extending Metadata Using Attributes.
The following example defines a class that contains a method marked with the ObsoleteAttribute. Any code that attempts to call the method will cause the compiler to issue a warning.
using System; public sealed class App { static void Main() { // The line below causes the compiler to issue a warning: // 'App.SomeDeprecatedMethod()' is obsolete: 'Do not call this method.' SomeDeprecatedMethod(); } // The method below is marked with the ObsoleteAttribute. // Any code that attempts to call this method will get a warning. [Obsolete("Do not call this method.")] private static void SomeDeprecatedMethod() { } }
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
