.NET Framework Class Library
AttributeGetCustomAttributes Method (Assembly, Type, Boolean)

Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Public Shared Function GetCustomAttributes ( _
	element As [%$TOPIC/ms130870_en-us_VS_110_1_0_0_0_0%], _
	attributeType As [%$TOPIC/ms130870_en-us_VS_110_1_0_0_0_1%], _
	inherit As [%$TOPIC/ms130870_en-us_VS_110_1_0_0_0_2%] _
) As [%$TOPIC/ms130870_en-us_VS_110_1_0_0_0_3%]()
public static [%$TOPIC/ms130870_en-us_VS_110_1_0_1_0_0%][] GetCustomAttributes(
	[%$TOPIC/ms130870_en-us_VS_110_1_0_1_0_1%] element,
	[%$TOPIC/ms130870_en-us_VS_110_1_0_1_0_2%] attributeType,
	[%$TOPIC/ms130870_en-us_VS_110_1_0_1_0_3%] inherit
)
public:
static array<[%$TOPIC/ms130870_en-us_VS_110_1_0_2_0_0%]^>^ GetCustomAttributes(
	[%$TOPIC/ms130870_en-us_VS_110_1_0_2_0_1%]^ element, 
	[%$TOPIC/ms130870_en-us_VS_110_1_0_2_0_2%]^ attributeType, 
	[%$TOPIC/ms130870_en-us_VS_110_1_0_2_0_3%] inherit
)
static member GetCustomAttributes : 
        element:[%$TOPIC/ms130870_en-us_VS_110_1_0_3_0_0%] * 
        attributeType:[%$TOPIC/ms130870_en-us_VS_110_1_0_3_0_1%] * 
        inherit:[%$TOPIC/ms130870_en-us_VS_110_1_0_3_0_2%] -> [%$TOPIC/ms130870_en-us_VS_110_1_0_3_0_3%][] 
public static function GetCustomAttributes(
	element : [%$TOPIC/ms130870_en-us_VS_110_1_0_4_0_0%], 
	attributeType : [%$TOPIC/ms130870_en-us_VS_110_1_0_4_0_1%], 
	inherit : [%$TOPIC/ms130870_en-us_VS_110_1_0_4_0_2%]
) : [%$TOPIC/ms130870_en-us_VS_110_1_0_4_0_3%][]

Parameters

element
Type: System.ReflectionAssembly

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

attributeType
Type: SystemType

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

inherit
Type: SystemBoolean

This parameter is ignored, and does not affect the operation of this method.

Return Value

Type: SystemAttribute
An Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.
Exceptions
ExceptionCondition
ArgumentNullException

element or attributeType is .

ArgumentException

attributeType is not derived from Attribute.

Remarks
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.

Examples

The following code example demonstrates the use of GetCustomAttributes, taking an Assembly as a parameter.

Imports System
Imports System.Reflection
Imports Microsoft.VisualBasic

<Assembly: AssemblyTitle("CustAttrs1VB")> 
<Assembly: AssemblyDescription("GetCustomAttributes() Demo")> 
<Assembly: AssemblyCompany("Microsoft")> 

Module DemoModule

    Sub Main()
        ' Get the Assembly type to access its metadata. 
        Dim assy As Reflection.Assembly = GetType(DemoModule).Assembly
        Dim attr As Attribute

        ' Iterate through all the attributes for the assembly. 
        For Each attr In Attribute.GetCustomAttributes(assy)

            ' Check for the AssemblyTitle attribute. 
            If TypeOf attr Is AssemblyTitleAttribute Then 
                ' Convert the attribute to access its data. 
                Dim attrTitle As AssemblyTitleAttribute = _
                    CType(attr, AssemblyTitleAttribute)
                Console.WriteLine("Assembly title is ""{0}"".", _
                    attrTitle.Title)

            ' Check for the AssemblyDescription attribute. 
            ElseIf TypeOf attr Is AssemblyDescriptionAttribute Then 
                ' Convert the attribute to access its data. 
                Dim attrDesc As AssemblyDescriptionAttribute = _
                    CType(attr, AssemblyDescriptionAttribute)
                Console.WriteLine("Assembly description is ""{0}"".", _
                    attrDesc.Description)

            ' Check for the AssemblyCompany attribute. 
            ElseIf TypeOf attr Is AssemblyCompanyAttribute Then 
                ' Convert the attribute to access its data. 
                Dim attrComp As AssemblyCompanyAttribute = _
                    CType(attr, AssemblyCompanyAttribute)
                Console.WriteLine("Assembly company is {0}.", _
                    attrComp.Company)
            End If 
        Next 
    End Sub 
End Module 

' Output: 
' Assembly company is Microsoft. 
' Assembly description is "GetCustomAttributes() Demo". 
' Assembly title is "CustAttrs1VB".
using System;
using System.Reflection;

[assembly: AssemblyTitle("CustAttrs1CS")]
[assembly: AssemblyDescription("GetCustomAttributes() Demo")]
[assembly: AssemblyCompany("Microsoft")]

namespace CustAttrs1CS {
    class DemoClass {
        static void Main(string[] args) {
            Type clsType = typeof(DemoClass);
            // Get the Assembly type to access its metadata.
            Assembly assy = clsType.Assembly;

            // Iterate through the attributes for the assembly. 
            foreach(Attribute attr in Attribute.GetCustomAttributes(assy)) {
                // Check for the AssemblyTitle attribute. 
                if (attr.GetType() == typeof(AssemblyTitleAttribute))
                    Console.WriteLine("Assembly title is \"{0}\".",
                        ((AssemblyTitleAttribute)attr).Title);

                // Check for the AssemblyDescription attribute. 
                else if (attr.GetType() == 
                    typeof(AssemblyDescriptionAttribute))
                    Console.WriteLine("Assembly description is \"{0}\".",
                        ((AssemblyDescriptionAttribute)attr).Description);

                // Check for the AssemblyCompany attribute. 
                else if (attr.GetType() == typeof(AssemblyCompanyAttribute))
                    Console.WriteLine("Assembly company is {0}.",
                        ((AssemblyCompanyAttribute)attr).Company);
            }
        }
    }
}

/*
 * Output:
 * Assembly company is Microsoft.
 * Assembly description is "GetCustomAttributes() Demo".
 * Assembly title is "CustAttrs1CS".
 */
#using <System.dll>

using namespace System;
using namespace System::Reflection;

[assembly:AssemblyTitle("CustAttrs1CS")];
[assembly:AssemblyDescription("GetCustomAttributes() Demo")];
[assembly:AssemblyCompany("Microsoft")];
namespace CustAttrs1CS
{
   ref class DemoClass
   {
   public:
      static void Main()
      {
         Type^ clsType = DemoClass::typeid;

         // Get the Assembly type to access its metadata.
         Assembly^ assy = clsType->Assembly;

         // Iterate through the attributes for the assembly.
         System::Collections::IEnumerator^ myEnum = Attribute::GetCustomAttributes( assy )->GetEnumerator();
         while ( myEnum->MoveNext() )
         {
            Attribute^ attr = safe_cast<Attribute^>(myEnum->Current);

            // Check for the AssemblyTitle attribute. 
            if ( attr->GetType() == AssemblyTitleAttribute::typeid )
                        Console::WriteLine( "Assembly title is \"{0}\".", (dynamic_cast<AssemblyTitleAttribute^>(attr))->Title );
            // Check for the AssemblyDescription attribute. 
            else 

            // Check for the AssemblyDescription attribute. 
            if ( attr->GetType() == AssemblyDescriptionAttribute::typeid )
                        Console::WriteLine( "Assembly description is \"{0}\".", (dynamic_cast<AssemblyDescriptionAttribute^>(attr))->Description );
            // Check for the AssemblyCompany attribute. 
            else 

            // Check for the AssemblyCompany attribute. 
            if ( attr->GetType() == AssemblyCompanyAttribute::typeid )
                        Console::WriteLine( "Assembly company is {0}.", (dynamic_cast<AssemblyCompanyAttribute^>(attr))->Company );
         }
      }
   };
}


/*
 * Output:
 * Assembly company is Microsoft.
 * Assembly description is "GetCustomAttributes() Demo".
 * Assembly title is "CustAttrs1CS".
 */
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8