Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

MemberInfo.GetCustomAttributes Method (Type, Boolean)

Updated: January 2010

When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

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

public abstract Object[] GetCustomAttributes(
	Type attributeType,
	bool inherit
)

Parameters

attributeType
Type: System.Type

The type of attribute to search for. Only attributes that are assignable to this type are returned.

inherit
Type: System.Boolean

true to search this member's inheritance chain to find the attributes; otherwise, false. This parameter is ignored for properties and events; see Remarks.

Return Value

Type: System.Object[]
An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

Implements

ICustomAttributeProvider.GetCustomAttributes(Type, Boolean)
_MemberInfo.GetCustomAttributes(Type, Boolean)

ExceptionCondition
TypeLoadException

A custom attribute type could not be loaded.

ArgumentNullException

If attributeType is null.

InvalidOperationException

This member belongs to a type that is loaded into the reflection-only context. See How to: Load Assemblies into the Reflection-Only Context.

This method ignores the inherit parameter for properties and events. To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

NoteNote:

In the .NET Framework version 2.0, this method returns security attributes on methods, constructors, and types if the attributes are stored in the new metadata format. Assemblies compiled with version 2.0 use this format. Dynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. See Emitting Declarative Security Attributes.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

January 2010

Clarified that the inherit parameter is ignored for properties and events.

Customer feedback.

Community Additions

ADD
Show:
© 2015 Microsoft