This documentation is archived and is not being maintained.
Attribute::GetCustomAttributes Method (Module, Boolean)
Visual Studio 2010
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: array<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 nullptr. |
The following code example demonstrates the use of GetCustomAttributes, taking a Module as a parameter.
using namespace System; using namespace System::Reflection; using namespace System::ComponentModel; // Assign some attributes to the module. // Set the module's CLSCompliant attribute to false // The CLSCompliant attribute is applicable for /target:module. [module:Description("A sample description")]; [module:CLSCompliant(false)]; namespace CustAttrs2CS { ref class DemoClass { public: static void Main() { Type^ clsType = DemoClass::typeid; // Get the Module type to access its metadata. Module^ module = clsType->Module; // Iterate through all the attributes for the module. System::Collections::IEnumerator^ myEnum1 = Attribute::GetCustomAttributes( module )->GetEnumerator(); while ( myEnum1->MoveNext() ) { Attribute^ attr = safe_cast<Attribute^>(myEnum1->Current); // Check for the Description attribute. if ( attr->GetType() == DescriptionAttribute::typeid ) Console::WriteLine( "Module {0} has the description \"{1}\".", module->Name, (dynamic_cast<DescriptionAttribute^>(attr))->Description ); // Check for the CLSCompliant attribute. else // Check for the CLSCompliant attribute. if ( attr->GetType() == CLSCompliantAttribute::typeid ) Console::WriteLine( "Module {0} {1} CLSCompliant.", module->Name, (dynamic_cast<CLSCompliantAttribute^>(attr))->IsCompliant ? (String^)"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.
Show: