Attribute.GetCustomAttribute Method (Assembly, Type, Boolean)
Retrieves a custom attribute applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option.
Assembly: mscorlib (in mscorlib.dll)
public static Attribute GetCustomAttribute( Assembly element, Type attributeType, bool inherit )
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.
- inherit
-
Type:
System.Boolean
This parameter is ignored, and does not affect the operation of this method.
Return Value
Type: System.AttributeA reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute.
| Exception | Condition |
|---|---|
| ArgumentNullException | element or attributeType is null. |
| ArgumentException | attributeType is not derived from Attribute. |
| AmbiguousMatchException | More than one of the requested attributes was found. |
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 illustrates the use of the GetCustomAttribute method taking an Assembly as a parameter.
using System; using System.Reflection; // Add an AssemblyDescription attribute [assembly: AssemblyDescription("A sample description")] namespace IsDef1CS { public class DemoClass { static void Main(string[] args) { // Get the class type to access its metadata. Type clsType = typeof(DemoClass); // Get the assembly object. Assembly assy = clsType.Assembly; // Store the assembly's name. String assyName = assy.GetName().Name; // See if the Assembly Description is defined. bool isdef = Attribute.IsDefined(assy, typeof(AssemblyDescriptionAttribute)); if (isdef) { // Affirm that the attribute is defined. Console.WriteLine("The AssemblyDescription attribute " + "is defined for assembly {0}.", assyName); // Get the description attribute itself. AssemblyDescriptionAttribute adAttr = (AssemblyDescriptionAttribute)Attribute.GetCustomAttribute( assy, typeof(AssemblyDescriptionAttribute)); // Display the description. if (adAttr != null) Console.WriteLine("The description is \"{0}\".", adAttr.Description); else Console.WriteLine("The description could not " + "be retrieved."); } else Console.WriteLine("The AssemblyDescription attribute is not " + "defined for assembly {0}.", assyName); } } } /* * Output: * The AssemblyDescription attribute is defined for assembly IsDef1CS. * The description is "A sample description". */
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
