Export (0) Print
Expand All

Attribute.GetCustomAttribute Method (ParameterInfo, Type, Boolean)

Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter.

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

static member GetCustomAttribute : 
        element:ParameterInfo * 
        attributeType:Type * 
        inherit:bool -> Attribute 

Parameters

element
Type: System.Reflection.ParameterInfo
An object derived from the ParameterInfo class that describes a parameter of a member of a class.
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 a null reference (Nothing in Visual Basic) if there is no such attribute.

ExceptionCondition
ArgumentNullException

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

ArgumentException

attributeType is not derived from Attribute.

AmbiguousMatchException

More than one of the requested attributes was found.

TypeLoadException

A custom attribute type cannot be loaded.

If element represents a parameter in a method of a derived type, the return value includes the inheritable custom attributes applied to the same parameter in the overridden base methods.

The following code example defines a custom parameter Attribute class and applies the custom attribute to a method in a derived class and the base of the derived class. The example shows the use of the GetCustomAttribute method to return the attributes.

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Community Additions

ADD
Show:
© 2014 Microsoft