Attribute.GetCustomAttributes Method (Module, Type)
.NET Framework 4
Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and the type of the custom attribute to search for.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- element
- Type: System.Reflection.Module
An object derived from the Module class that describes a portable executable file.
- attributeType
- Type: System.Type
The type, or a base type, of the custom attribute to search for.
Return Value
Type: 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. |
The following code example demonstrates the use of GetCustomAttributes, taking a Module as a parameter.
using System; using System.Reflection; using System.ComponentModel; // Assign some attributes to the module. [module:Description("A sample description")] // Set the module's CLSCompliant attribute to false // The CLSCompliant attribute is applicable for /target:module. [module:CLSCompliant(false)] namespace CustAttrs2CS { class DemoClass { static void Main(string[] args) { Type clsType = typeof(DemoClass); // Get the Module type to access its metadata. Module module = clsType.Module; // Iterate through all the attributes for the module. foreach(Attribute attr in Attribute.GetCustomAttributes(module)) { // Check for the Description attribute. if (attr.GetType() == typeof(DescriptionAttribute)) Console.WriteLine("Module {0} has the description " + "\"{1}\".", module.Name, ((DescriptionAttribute)attr).Description); // Check for the CLSCompliant attribute. else if (attr.GetType() == typeof(CLSCompliantAttribute)) Console.WriteLine("Module {0} {1} CLSCompliant.", module.Name, ((CLSCompliantAttribute)attr).IsCompliant ? "is" : "is not"); } } } } /* * Output: * Module CustAttrs2CS.exe is not CLSCompliant. * Module CustAttrs2CS.exe has the description "A sample description". */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.