CustomAttributeExtensions.GetCustomAttributes Method (MemberInfo, Type, Boolean)

.NET Framework 4.5

Retrieves a collection of custom attributes of a specified type that are applied to a specified member, and optionally inspects the ancestors of that member.

Namespace:  System.Reflection
Assemblies:   mscorlib (in mscorlib.dll)
  System.Reflection.Extensions (in System.Reflection.Extensions.dll)

'Declaration
<ExtensionAttribute> _
Public Shared Function GetCustomAttributes ( _
	element As MemberInfo, _
	attributeType As Type, _
	inherit As Boolean _
) As IEnumerable(Of Attribute)

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.Collections.Generic.IEnumerable(Of Attribute)
A collection of the custom attributes that are applied to element and that match attributeType, or an empty collection if no such attributes exist.

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

ArgumentException

attributeType is not derived from Attribute.

NotSupportedException

element is not a constructor, method, property, event, type, or field.

TypeLoadException

A custom attribute type cannot be loaded.

.NET Framework

Supported in: 4.6, 4.5

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft