Attribute.GetCustomAttributes Method (Module, Boolean)
.NET Framework (current version)
Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and an ignored search option.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- element
-
Type:
System.Reflection.Module
An object derived from the Module class that describes a portable executable file.
- inherit
-
Type:
System.Boolean
This parameter is ignored, and does not affect the operation of this method.
Return Value
Type: System.Attribute[]An Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist.
| Exception | Condition |
|---|---|
| ArgumentNullException | element or attributeType is null. |
The return value contains the custom attributes for ancestors of element if inherit is true.
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". */
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Show: