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

Inheritance diagram for System.ObsoleteAttribute:

Collaboration diagram for System.ObsoleteAttribute:

Public Member Functions
	ObsoleteAttribute ()
	Initializes a new instance of the T:System.ObsoleteAttribute class with default properties. More...

	ObsoleteAttribute (string message)
	Initializes a new instance of the T:System.ObsoleteAttribute class with a specified workaround message. More...

	ObsoleteAttribute (string message, bool error)
	Initializes a new instance of the T:System.ObsoleteAttribute class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error. More...

Public Member Functions inherited from System.Attribute
override bool	Equals (object obj)
	Returns a value that indicates whether this instance is equal to a specified object. More...

override int	GetHashCode ()
	Returns the hash code for this instance. More...

virtual bool	Match (object obj)
	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. More...

virtual bool	IsDefaultAttribute ()
	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. More...

Properties
string	Message `[get]`
	Gets the workaround message, including a description of the alternative program elements. More...

bool	IsError `[get]`
	Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error. More...

Additional Inherited Members
Static Public Member Functions inherited from System.Attribute
static Attribute []	GetCustomAttributes (MemberInfo element, Type type)
	Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. More...

static Attribute []	GetCustomAttributes (MemberInfo element, Type type, bool inherit)
	Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. More...

static Attribute []	GetCustomAttributes (MemberInfo element)
	Retrieves an array of the custom attributes applied to a member of a type. A parameter specifies the member. More...

static Attribute []	GetCustomAttributes (MemberInfo element, bool inherit)
	Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. More...

static bool	IsDefined (MemberInfo element, Type attributeType)
	Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. More...

static bool	IsDefined (MemberInfo element, Type attributeType, bool inherit)
	Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. More...

static Attribute	GetCustomAttribute (MemberInfo element, Type attributeType)
	Retrieves a custom attribute applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. More...

static Attribute	GetCustomAttribute (MemberInfo element, Type attributeType, bool inherit)
	Retrieves a custom attribute applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. More...

static Attribute []	GetCustomAttributes (ParameterInfo element)
	Retrieves an array of the custom attributes applied to a method parameter. A parameter specifies the method parameter. More...

static Attribute []	GetCustomAttributes (ParameterInfo element, Type attributeType)
	Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. More...

static Attribute []	GetCustomAttributes (ParameterInfo element, Type attributeType, bool inherit)
	Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. More...

static Attribute []	GetCustomAttributes (ParameterInfo element, bool inherit)
	Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and whether to search ancestors of the method parameter. More...

static bool	IsDefined (ParameterInfo element, Type attributeType)
	Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. More...

static bool	IsDefined (ParameterInfo element, Type attributeType, bool inherit)
	Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. More...

static Attribute	GetCustomAttribute (ParameterInfo element, Type attributeType)
	Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. More...

static Attribute	GetCustomAttribute (ParameterInfo element, Type attributeType, bool inherit)
	Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. More...

static Attribute []	GetCustomAttributes (Module element, Type attributeType)
	Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and the type of the custom attribute to search for. More...

static Attribute []	GetCustomAttributes (Module element)
	Retrieves an array of the custom attributes applied to a module. A parameter specifies the module. More...

static Attribute []	GetCustomAttributes (Module element, bool inherit)
	Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and an ignored search option. More...

static Attribute []	GetCustomAttributes (Module element, Type attributeType, bool inherit)
	Retrieves an array of the custom attributes applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. More...

static bool	IsDefined (Module element, Type attributeType)
	Determines whether any custom attributes of a specified type are applied to a module. Parameters specify the module, and the type of the custom attribute to search for. More...

static bool	IsDefined (Module element, Type attributeType, bool inherit)
	Determines whether any custom attributes are applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. More...

static Attribute	GetCustomAttribute (Module element, Type attributeType)
	Retrieves a custom attribute applied to a module. Parameters specify the module, and the type of the custom attribute to search for. More...

static Attribute	GetCustomAttribute (Module element, Type attributeType, bool inherit)
	Retrieves a custom attribute applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. More...

static Attribute []	GetCustomAttributes (Assembly element, Type attributeType)
	Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for. More...

static Attribute []	GetCustomAttributes (Assembly element, Type attributeType, bool inherit)
	Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. More...

static Attribute []	GetCustomAttributes (Assembly element)
	Retrieves an array of the custom attributes applied to an assembly. A parameter specifies the assembly. More...

static Attribute []	GetCustomAttributes (Assembly element, bool inherit)
	Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and an ignored search option. More...

static bool	IsDefined (Assembly element, Type attributeType)
	Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for. More...

static bool	IsDefined (Assembly element, Type attributeType, bool inherit)
	Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. More...

static Attribute	GetCustomAttribute (Assembly element, Type attributeType)
	Retrieves a custom attribute applied to a specified assembly. Parameters specify the assembly and the type of the custom attribute to search for. More...

static Attribute	GetCustomAttribute (Assembly element, Type attributeType, bool inherit)
	Retrieves a custom attribute applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. More...

Public Attributes inherited from System.Attribute
virtual object	TypeId => GetType()
	When implemented in a derived class, gets a unique identifier for this T:System.Attribute. More...

Protected Member Functions inherited from System.Attribute
	Attribute ()
	Initializes a new instance of the T:System.Attribute class. More...

Detailed Description

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

Definition at line 10 of file ObsoleteAttribute.cs.

Constructor & Destructor Documentation

◆ ObsoleteAttribute() [1/3]

System.ObsoleteAttribute.ObsoleteAttribute ( )

Initializes a new instance of the T:System.ObsoleteAttribute class with default properties.

Definition at line 43 of file ObsoleteAttribute.cs.

◆ ObsoleteAttribute() [2/3]

System.ObsoleteAttribute.ObsoleteAttribute ( string message )

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

Parameters

message The text string that describes alternative workarounds.

Definition at line 52 of file ObsoleteAttribute.cs.

◆ ObsoleteAttribute() [3/3]

System.ObsoleteAttribute.ObsoleteAttribute	(	string	message,
		bool	error
	)

Initializes a new instance of the T:System.ObsoleteAttribute class with a workaround message and a Boolean value indicating whether the obsolete element usage is considered an error.

Parameters

message	The text string that describes alternative workarounds.
error	`true` if the obsolete element usage generates a compiler error; `false` if it generates a compiler warning.

Definition at line 63 of file ObsoleteAttribute.cs.

Property Documentation

◆ IsError

bool System.ObsoleteAttribute.IsError

get

Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error.

Returns: true if the obsolete element usage is considered an error; otherwise, false. The default is false.

Definition at line 33 of file ObsoleteAttribute.cs.

◆ Message

string System.ObsoleteAttribute.Message

get

Gets the workaround message, including a description of the alternative program elements.

Returns: The workaround text string.

Definition at line 20 of file ObsoleteAttribute.cs.

The documentation for this class was generated from the following file:

D:/All cs/System/ObsoleteAttribute.cs

Public Member Functions

Properties

Additional Inherited Members