Attribute.GetCustomAttribute Method (MemberInfo, Type, Boolean)

Retrieves a custom attribute 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)

Syntax

'Declaration
Public Shared Function GetCustomAttribute ( _
    element As MemberInfo, _
    attributeType As Type, _
    inherit As Boolean _
) As Attribute
public static Attribute GetCustomAttribute(
    MemberInfo element,
    Type attributeType,
    bool inherit
)

Parameters

  • attributeType
    Type: System.Type
    The type, or a base type, of the custom attribute to search for.
  • inherit
    Type: System.Boolean
    If true, specifies to also search the ancestors of element for custom attributes.

Return Value

Type: System.Attribute
A reference to the single custom attribute of type attributeType that is applied to element, or nulla null reference (Nothing in Visual Basic) if there is no such attribute.

Exceptions

Exception Condition
ArgumentNullException

element or attributeType is nulla null reference (Nothing in Visual Basic).

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.