This topic has not yet been rated - Rate this topic

CustomAttributeExtensions.GetCustomAttribute Method (MemberInfo, Type)

.NET Framework 4.5

Retrieves a custom attribute of a specified type that is applied to a specified member.

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

public static Attribute GetCustomAttribute(
	this MemberInfo element,
	Type attributeType
)

Parameters

element: Type: System.Reflection.MemberInfo
The member to inspect.

attributeType: Type: System.Type
The type of attribute to search for.

Return Value

Type: System.Attribute
A custom attribute that matches attributeType, or null if no such attribute is found.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type MemberInfo. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	element or attributeType is null.
ArgumentException	attributeType is not derived from Attribute.
NotSupportedException	element is not a constructor, method, property, event, type, or field.
AmbiguousMatchException	More than one of the requested attributes was found.
TypeLoadException	A custom attribute type cannot be loaded.

Remarks

Use the GetCustomAttributes extension method if you expect more than one value to be returned, or AmbiguousMatchException will be thrown.

Version Information

.NET Framework

Supported in: 4.5

.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.

Reference

CustomAttributeExtensions Class

GetCustomAttribute Overload

System.Reflection Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)