Attribute::GetCustomAttributes Method (Assembly^, Type^)
Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for.
Assembly: mscorlib (in mscorlib.dll)
public: static array<Attribute^>^ GetCustomAttributes( Assembly^ element, Type^ attributeType )
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: array<System::Attribute^>^An Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.
| Exception | Condition |
|---|---|
| ArgumentNullException | element or attributeType is null. |
| ArgumentException | attributeType is not derived from Attribute. |
Note |
|---|
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 demonstrates the use of GetCustomAttributes, taking an Assembly as a parameter.
using namespace System; using namespace System::Reflection; [assembly:AssemblyTitle("CustAttrs1CPP")]; [assembly:AssemblyDescription("GetCustomAttributes() Demo")]; [assembly:AssemblyCompany("Microsoft")]; ref class Example {}; static void main() { Type^ clsType = Example::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 if ( attr->GetType() == AssemblyCompanyAttribute::typeid ) Console::WriteLine( "Assembly company is {0}.", (dynamic_cast<AssemblyCompanyAttribute^>(attr))->Company ); } } // The example displays the following output: // Assembly description is "GetCustomAttributes() Demo". // Assembly company is Microsoft. // Assembly title is "CustAttrs1CPP".
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
