Skip to main content
:ProfileText:
Home Library Learn Samples Downloads Support Community Forums
ObsoleteAttribute Class
.NET Framework Class Library
ObsoleteAttribute Class

Marks the program elements that are no longer in use. This class cannot be inherited.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    SystemObsoleteAttribute

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax 
<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_0%]> _
<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_1%]([%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_2%].Class Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_3%].Struct Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_4%].Enum Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_5%].Constructor Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_6%].Method Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_7%].Property Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_8%].Field Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_9%].Event Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_10%].Interface Or [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_11%].Delegate, Inherited := False)> _
<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_12%](True)> _
Public NotInheritable Class ObsoleteAttribute _
	Inherits [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_0_0_13%]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_0%]]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_1%]([%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_2%].Class|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_3%].Struct|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_4%].Enum|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_5%].Constructor|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_6%].Method|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_7%].Property|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_8%].Field|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_9%].Event|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_10%].Interface|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_11%].Delegate, Inherited = false)]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_12%](true)]
public sealed class ObsoleteAttribute : [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_1_0_13%]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_0%]]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_1%]([%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_2%]::Class|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_3%]::Struct|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_4%]::Enum|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_5%]::Constructor|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_6%]::Method|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_7%]::Property|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_8%]::Field|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_9%]::Event|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_10%]::Interface|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_11%]::Delegate, Inherited = false)]
[[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_12%](true)]
public ref class ObsoleteAttribute sealed : public [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_2_0_13%]
[<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_0%]>]
[<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_1%]>]
[<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_2%]([%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_3%].Class|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_4%].Struct|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_5%].Enum|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_6%].Constructor|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_7%].Method|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_8%].Property|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_9%].Field|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_10%].Event|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_11%].Interface|[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_12%].Delegate, Inherited = false)>]
[<[%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_13%](true)>]
type ObsoleteAttribute =  
    class 
        inherit [%$TOPIC/fwz0y5c2_en-us_VS_110_2_0_3_0_14%] 
    end

The ObsoleteAttribute type exposes the following members.

Constructors
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ObsoleteAttributeInitializes a new instance of the ObsoleteAttribute class with default properties.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ObsoleteAttribute(String)Initializes a new instance of the ObsoleteAttribute class with a specified workaround message.
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps 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.
Top
Properties
  NameDescription
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps IsErrorGets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.
Public property Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps MessageGets the workaround message, including a description of the alternative program elements.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Supported by the XNA Framework MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method Supported by the XNA Framework Supported by Portable Class Library Supported in .NET for Windows Store apps ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

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.

Examples

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.

Module Module1

    Sub Main()
        ' The line below causes the compiler to issue a warning: 
        ' 'App.SomeDeprecatedMethod()' is obsolete: 'Do not call this method.'
        SomeDeprecatedMethod()

    End Sub 
    ' 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 Sub SomeDeprecatedMethod()

    End Sub 
End Module
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() { }
}
using namespace System;


// 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.")]
void SomeDeprecatedMethod()
{
}

int main()
{
    // The line below causes the compiler to issue a warning: 
    // 'SomeDeprecatedMethod()': marked as obsolete 
    // Message: 'Do not call this method.'
    SomeDeprecatedMethod();
}
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8
Platforms

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.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System Namespace
Attribute

Other Resources

Extending Metadata Using Attributes

© 2013 Microsoft. All rights reserved.