Export (0) Print
Expand All

CustomAttributeExtensions.GetCustomAttribute Method (ParameterInfo, Type, Boolean)

.NET Framework 4.5

Retrieves a custom attribute of a specified type that is applied to a specified parameter, and optionally inspects the ancestors of that parameter.

Namespace:  System.Reflection
Assemblies:   System.Reflection.Extensions (in System.Reflection.Extensions.dll)
  mscorlib (in mscorlib.dll)

public static Attribute GetCustomAttribute(
	this ParameterInfo element,
	Type attributeType,
	bool inherit
)

Parameters

element
Type: System.Reflection.ParameterInfo

The parameter to inspect.

attributeType
Type: System.Type

The type of attribute to search for.

inherit
Type: System.Boolean

true to inspect the ancestors of element; otherwise, false.

Return Value

Type: System.Attribute
A custom attribute matching attributeType, or null if no such attribute is found.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ParameterInfo. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
ArgumentNullException

element or attributeType is null.

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.

Use the GetCustomAttributes extension method if you expect more than one value to be returned, or AmbiguousMatchException will be thrown.

.NET Framework

Supported in: 4.6

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8

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

Show:
© 2014 Microsoft