Programming Visual Basic .NET

Name

Obsolete

Valid on

Class, Struct, Enum, Constructor, Method, Property, Field, Event, Interface, and Delegate

Description

Indicates that the given program element is obsolete.

The ObsoleteAttribute class has three overloads. The first takes no parameters and merely marks a program element as obsolete. The second overload looks like this:

Public Overloads Sub New(ByVal message As String)

The message parameter gives a free-form text message, which can be shown to a programmer making use of the obsolete program element. The third overload looks like this:

Public Overloads Sub New(ByVal message As String, ByVal error As Boolean)

In addition to the message parameter, this overload has an error parameter, which indicates whether it is an error to use the given program element.

The properties of the ObsoleteAttribute class are:

IsError

Indicates whether it is an error to use the program element. The type is Boolean. The default is False.

Message

A free-form text message, which can be shown to a programmer making use of the obsolete program element.