CustomAttributeExtensions.GetCustomAttribute Method

Reference

Definition

Namespace:: System.Reflection

Assembly:: System.Reflection.Extensions.dll

Assembly:: System.Runtime.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Retrieves a custom attribute that is applied to a specified element.

Overloads

GetCustomAttribute(Assembly, Type)	Retrieves a custom attribute of a specified type that is applied to a specified assembly.
GetCustomAttribute(MemberInfo, Type)	Retrieves a custom attribute of a specified type that is applied to a specified member.
GetCustomAttribute(Module, Type)	Retrieves a custom attribute of a specified type that is applied to a specified module.
GetCustomAttribute(ParameterInfo, Type)	Retrieves a custom attribute of a specified type that is applied to a specified parameter.
GetCustomAttribute(MemberInfo, Type, Boolean)	Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member.
GetCustomAttribute(ParameterInfo, Type, Boolean)	Retrieves a custom attribute of a specified type that is applied to a specified parameter, and optionally inspects the ancestors of that parameter.
GetCustomAttribute<T>(ParameterInfo, Boolean)	Retrieves a custom attribute of a specified type that is applied to a specified parameter, and optionally inspects the ancestors of that parameter.
GetCustomAttribute<T>(MemberInfo, Boolean)	Retrieves a custom attribute of a specified type that is applied to a specified member, and optionally inspects the ancestors of that member.
GetCustomAttribute<T>(ParameterInfo)	Retrieves a custom attribute of a specified type that is applied to a specified parameter.
GetCustomAttribute<T>(Module)	Retrieves a custom attribute of a specified type that is applied to a specified module.
GetCustomAttribute<T>(MemberInfo)	Retrieves a custom attribute of a specified type that is applied to a specified member.
GetCustomAttribute<T>(Assembly)	Retrieves a custom attribute of a specified type that is applied to a specified assembly.

GetCustomAttribute(Assembly, Type)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified assembly.

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::Assembly ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.Assembly element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.Assembly element, Type attributeType);

static member GetCustomAttribute : System.Reflection.Assembly * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As Assembly, attributeType As Type) As Attribute

Parameters

element: Assembly

The assembly to inspect.

attributeType: Type

The type of attribute to search for.

Returns

Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

Exceptions

ArgumentNullException

element or attributeType is null.

ArgumentException

attributeType is not derived from Attribute.

AmbiguousMatchException

More than one of the requested attributes was found.

Remarks

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

Applies to

GetCustomAttribute(MemberInfo, Type)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified member.

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::MemberInfo ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType);

static member GetCustomAttribute : System.Reflection.MemberInfo * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As MemberInfo, attributeType As Type) As Attribute

Parameters

element: MemberInfo

The member to inspect.

attributeType: Type

The type of attribute to search for.

Returns

Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

Exceptions

ArgumentNullException

element or attributeType is null.

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.

Remarks

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

Applies to

GetCustomAttribute(Module, Type)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified module.

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::Module ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.Module element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.Module element, Type attributeType);

static member GetCustomAttribute : System.Reflection.Module * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As Module, attributeType As Type) As Attribute

Parameters

element: Module

The module to inspect.

attributeType: Type

The type of attribute to search for.

Returns

Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

Exceptions

ArgumentNullException

element or attributeType is null.

ArgumentException

attributeType is not derived from Attribute.

AmbiguousMatchException

More than one of the requested attributes was found.

Remarks

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

Applies to

GetCustomAttribute(ParameterInfo, Type)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified parameter.

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::ParameterInfo ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType);

static member GetCustomAttribute : System.Reflection.ParameterInfo * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As ParameterInfo, attributeType As Type) As Attribute

Parameters

element: ParameterInfo

The parameter to inspect.

attributeType: Type

The type of attribute to search for.

Returns

Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

Exceptions

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.

Remarks

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

Applies to

GetCustomAttribute(MemberInfo, Type, Boolean)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::MemberInfo ^ element, Type ^ attributeType, bool inherit);

public static Attribute GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType, bool inherit);

public static Attribute? GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType, bool inherit);

static member GetCustomAttribute : System.Reflection.MemberInfo * Type * bool -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As MemberInfo, attributeType As Type, inherit As Boolean) As Attribute

Parameters

element: MemberInfo

The member to inspect.

attributeType: Type

The type of attribute to search for.

inherit: Boolean

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

Returns

Attribute

A custom attribute that matches attributeType, or null if no such attribute is found.

Exceptions

ArgumentNullException

element or attributeType is null.

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.

Remarks

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

Applies to

GetCustomAttribute(ParameterInfo, Type, Boolean)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

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

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::ParameterInfo ^ element, Type ^ attributeType, bool inherit);

public static Attribute GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType, bool inherit);

public static Attribute? GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType, bool inherit);

static member GetCustomAttribute : System.Reflection.ParameterInfo * Type * bool -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As ParameterInfo, attributeType As Type, inherit As Boolean) As Attribute

Parameters

element: ParameterInfo

The parameter to inspect.

attributeType: Type

The type of attribute to search for.

inherit: Boolean

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

Returns

Attribute

A custom attribute matching attributeType, or null if no such attribute is found.

Exceptions

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.

Remarks

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

Applies to

GetCustomAttribute<T>(ParameterInfo, Boolean)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

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

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::ParameterInfo ^ element, bool inherit);

public static T GetCustomAttribute<T> (this System.Reflection.ParameterInfo element, bool inherit) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.ParameterInfo element, bool inherit) where T : Attribute;

static member GetCustomAttribute : System.Reflection.ParameterInfo * bool -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As ParameterInfo, inherit As Boolean) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: ParameterInfo

The parameter to inspect.

inherit: Boolean

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

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

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.

Remarks

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

Applies to

GetCustomAttribute<T>(MemberInfo, Boolean)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

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

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::MemberInfo ^ element, bool inherit);

public static T GetCustomAttribute<T> (this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

static member GetCustomAttribute : System.Reflection.MemberInfo * bool -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As MemberInfo, inherit As Boolean) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: MemberInfo

The member to inspect.

inherit: Boolean

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

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

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.

Remarks

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

Applies to

GetCustomAttribute<T>(ParameterInfo)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified parameter.

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::ParameterInfo ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.ParameterInfo element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.ParameterInfo element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.ParameterInfo -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As ParameterInfo) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: ParameterInfo

The parameter to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

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.

Remarks

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

Applies to

GetCustomAttribute<T>(Module)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified module.

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::Module ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.Module element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.Module element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.Module -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As Module) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: Module

The module to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

AmbiguousMatchException

More than one of the requested attributes was found.

Remarks

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

Applies to

GetCustomAttribute<T>(MemberInfo)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified member.

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::MemberInfo ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.MemberInfo element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.MemberInfo element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.MemberInfo -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As MemberInfo) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: MemberInfo

The member to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

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.

Remarks

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

Applies to

GetCustomAttribute<T>(Assembly)

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Source:: CustomAttributeExtensions.cs

Retrieves a custom attribute of a specified type that is applied to a specified assembly.

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::Assembly ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.Assembly element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.Assembly element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.Assembly -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As Assembly) As T

Type Parameters

T

The type of attribute to search for.

Parameters

element: Assembly

The assembly to inspect.

Returns

A custom attribute that matches T, or null if no such attribute is found.

Exceptions

ArgumentNullException

element is null.

AmbiguousMatchException

More than one of the requested attributes was found.

Remarks

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

Applies to

Share via

CustomAttributeExtensions.GetCustomAttribute Method

Definition

Overloads

GetCustomAttribute(Assembly, Type)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute(MemberInfo, Type)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute(Module, Type)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute(ParameterInfo, Type)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute(MemberInfo, Type, Boolean)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute(ParameterInfo, Type, Boolean)

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(ParameterInfo, Boolean)

Type Parameters

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(MemberInfo, Boolean)

Type Parameters

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(ParameterInfo)

Type Parameters

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(Module)

Type Parameters

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(MemberInfo)

Type Parameters

Parameters

Returns

Exceptions

Remarks

Applies to

GetCustomAttribute<T>(Assembly)

Type Parameters

Parameters

Returns

Exceptions