Export (0) Print
Expand All

ObsoleteAttribute.ObsoleteAttribute(String) Constructor

Initializes a new instance of the ObsoleteAttribute class with a specified workaround message.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

public:
ObsoleteAttribute (
	String^ message
)
public ObsoleteAttribute (
	String message
)
public function ObsoleteAttribute (
	message : String
)
Not applicable.

Parameters

message

The text string that describes alternative workarounds.

The following table shows the initial property values for an instance of ObsoleteAttribute.

Property

Value

IsError

false.

Message

The workaround message.

The following example demonstrates the ObsoleteAttribute(String) constructor. It contains a function which calls a method that has been designated as obsolete, then attempts to catch an exception using a try/catch block.The parameter string is displayed as a workaround message.

using namespace System;
public ref class ObsoleteAttrib_Cons1
{
public:

   // Mark the method as 'Obsolete' with message as parameter.

   [ObsoleteAttribute("This function will be removed from future Versions. Use another function 'NewFunction'")]
   String^ OldFunction()
   {
      return "This is the String from old function.";
   }


   // Create another function which is replacement to the 'OldFunction'.
   String^ NewFunction()
   {
      return "This is the String from new function.";
   }

};

int main()
{
   try
   {
      ObsoleteAttrib_Cons1^ myObsolete = gcnew ObsoleteAttrib_Cons1;
      Console::WriteLine( myObsolete->OldFunction() );
      Console::WriteLine( myObsolete->NewFunction() );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The Exception is : {0}", e->Message );
   }

}


import System.*;

public class ObsoleteAttrib_Cons1
{
    // Mark the method as 'Obsolete' with message as parameter.

    /** @attribute ObsoleteAttribute("This function will be removed from future"
        + "Versions.Use another function 'NewFunction'")
     */
    public String OldFunction()
    {
        return "This is the String from old function.";
    } //OldFunction

    // Create the another function which is replacement to the 'OldFunction'.
    public String NewFunction()
    {
        return "This is the String from new function.";
    } //NewFunction
} //ObsoleteAttrib_Cons1

public class TestObsolete2
{
    public static void main(String[] args)
    {
        try {
            ObsoleteAttrib_Cons1 myObsolete = new ObsoleteAttrib_Cons1();
            Console.WriteLine(myObsolete.OldFunction());
            Console.WriteLine(myObsolete.NewFunction());
        }
        catch (System.Exception e) {
            Console.WriteLine("The Exception is :" + e.get_Message());
        }
    } //main
} //TestObsolete2

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft