CustomAttributeExtensions.GetCustomAttribute Method (MemberInfo, Type, Boolean)

.NET Framework 4.5

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.

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

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

.NET Framework

Supported in: 4.6, 4.5

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft