Attribute.GetCustomAttribute Method (Assembly, Type)

 

Retrieves a custom attribute applied to a specified assembly. Parameters specify the assembly and the type of the custom attribute to search for.

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

static member GetCustomAttribute : 
        element:Assembly *
        attributeType:Type -> Attribute

Parameters

element
Type: System.Reflection.Assembly

An object derived from the Assembly class that describes a reusable collection of modules.

attributeType
Type: System.Type

The type, or a base type, of the custom attribute to search for.

Return Value

Type: System.Attribute

A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.

Exception Condition
ArgumentNullException

element or attributeType is null.

ArgumentException

attributeType is not derived from Attribute.

AmbiguousMatchException

More than one of the requested attributes was found.

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

System_CAPS_noteNote

Starting with the .NET Framework version 2.0, this method returns security attributes 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 illustrates the use of the GetCustomAttribute method taking an Assembly as a parameter.

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

.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: