MemberInfo.GetCustomAttributes Method (Type, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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)

abstract GetCustomAttributes : 
        attributeType:Type *
        inherit:bool -> Object[]

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.

Exception Condition
TypeLoadException

A custom attribute type cannot 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.

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

The following example defines a class named BaseClass that has two non-inherited members: a thread static field named total and a non-CLS-compliant method named MethodA. A class named DerivedClass inherits from BaseClass and overrides its MethodA method. Note that no attributes are applied to the members of DerivedClass. The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. Because inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. As the output from the example shows, the total field is decorated with the ThreadStaticAttribute attribute, and the MethodA method is decorated with the CLSCompliantAttribute attribute.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: