CustomAttributeExtensions.GetCustomAttribute Method (MemberInfo, Type, Boolean)

.NET Framework (current version)
 

Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member.

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

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

Parameters

element
Type: System.Reflection.MemberInfo

The member to inspect.

attributeType
Type: System.Type

The type of attribute to search for.

inherit
Type: System.Boolean

true to inspect the ancestors of element; otherwise, false.

Return Value

Type: System.Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

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.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: