This documentation is archived and is not being maintained.

Attribute.GetCustomAttributes Method (MemberInfo, Boolean)

Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.

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

public static function GetCustomAttributes(
	element : MemberInfo, 
	inherit : boolean
) : Attribute[]

Parameters

element
Type: System.Reflection.MemberInfo

An object derived from the MemberInfo class that describes a constructor, event, field, method, or property member of a class.

inherit
Type: System.Boolean

If true, specifies to also search the ancestors of element for custom attributes.

Return Value

Type: System.Attribute[]
An Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.

ExceptionCondition
ArgumentNullException

element is a null reference (Nothing in Visual Basic).

NotSupportedException

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

TypeLoadException

A custom attribute type cannot be loaded.

The return value contains the custom attributes for ancestors of element if inherit is true.

NoteNote:

Starting with 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 or later use the new 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 code example demonstrates the use of GetCustomAttributes, taking a MemberInfo as a parameter.

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

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
Show: