MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes MemberInfo.GetCustomAttributes Method

Definition

Gibt beim Überschreiben in einer abgeleiteten Klasse für diesen Member angewendete benutzerdefinierte Attribute zurück.When overridden in a derived class, returns custom attributes applied to this member.

Überlädt

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Gibt beim Überschreiben in einer abgeleiteten Klasse ein Array mit allen benutzerdefinierten Attributen zurück, die auf diesen Member angewendet wurden.When overridden in a derived class, returns an array of all custom attributes applied to this member.

GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean)

Gibt beim Überschreiben in einer abgeleiteten Klasse ein Array aus benutzerdefinierten Attributen zurück, die auf diesen Member angewendet und von Type identifiziert wurden.When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean) GetCustomAttributes(Boolean)

Gibt beim Überschreiben in einer abgeleiteten Klasse ein Array mit allen benutzerdefinierten Attributen zurück, die auf diesen Member angewendet wurden.When overridden in a derived class, returns an array of all custom attributes applied to this member.

public:
 abstract cli::array <System::Object ^> ^ GetCustomAttributes(bool inherit);
public abstract object[] GetCustomAttributes (bool inherit);
abstract member GetCustomAttributes : bool -> obj[]
Public MustOverride Function GetCustomAttributes (inherit As Boolean) As Object()

Parameter

inherit
Boolean Boolean Boolean Boolean

true, um die Vererbungskette dieses Members nach den Attributen zu durchsuchen; andernfalls false.true to search this member's inheritance chain to find the attributes; otherwise, false. Dieser Parameter wird für Eigenschaften und Ereignisse ignoriert.This parameter is ignored for properties and events.

Gibt zurück

Object[]

Ein Array, das sämtliche auf diesen Member angewendeten benutzerdefinierten Attribute enthält, oder ein Array ohne Elemente, wenn keine Attribute definiert sind.An array that contains all the custom attributes applied to this member, or an array with zero elements if no attributes are defined.

Implementiert

Ausnahmen

Dieser Member gehört zu einem Typ, der in den auf Reflexionen beschränkten Kontext geladen wird.This member belongs to a type that is loaded into the reflection-only context. Weitere Informationen finden Sie unter Vorgehensweise: Laden von Assemblys in den reflexionsbezogenen Kontext.See How to: Load Assemblies into the Reflection-Only Context.

Ein benutzerdefinierter Attributtyp konnte nicht geladen werden.A custom attribute type could not be loaded.

Beispiele

Im folgenden Beispiel wird ein benutzerdefiniertes Attribut definiert und das MyClass.MyMethod-Attribut zugeordnet, das-Attribut wird zur Laufzeit abgerufen, und das Ergebnis wird angezeigt.The following example defines a custom attribute and associates the attribute with MyClass.MyMethod, retrieves the attribute at run time, and displays the result.

using namespace System;
using namespace System::Reflection;

// Define a custom attribute with one named parameter.

[AttributeUsage(AttributeTargets::All)]
public ref class MyAttribute: public Attribute
{
private:
   String^ myName;

public:
   MyAttribute( String^ name )
   {
      myName = name;
   }

   property String^ Name 
   {
      String^ get()
      {
         return myName;
      }
   }
};

// Define a class that has the custom attribute associated with one of its members.
public ref class MyClass1
{
public:

   [MyAttribute("This is an example attribute.")]
   void MyMethod( int i )
   {
      return;
   }
};

int main()
{
   try
   {
      // Get the type of MyClass1.
      Type^ myType = MyClass1::typeid;

      // Get the members associated with MyClass1.
      array<MemberInfo^>^myMembers = myType->GetMembers();

      // Display the attributes for each of the members of MyClass1.
      for ( int i = 0; i < myMembers->Length; i++ )
      {
         array<Object^>^myAttributes = myMembers[ i ]->GetCustomAttributes( true );
         if ( myAttributes->Length > 0 )
         {
            Console::WriteLine( "\nThe attributes for the member {0} are: \n", myMembers[ i ] );
            for ( int j = 0; j < myAttributes->Length; j++ )
               Console::WriteLine( "The type of the attribute is {0}.", myAttributes[ j ] );
         }
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "An exception occurred: {0}", e->Message );
   }
}
using System;
using System.Reflection;

// Define a custom attribute with one named parameter.
[AttributeUsage(AttributeTargets.All)]
public class MyAttribute : Attribute
{
    private string myName;
    public MyAttribute(string name)
    {
        myName = name;
    }
    public string Name
    {
        get
        {
            return myName;
        }
    }
}

// Define a class that has the custom attribute associated with one of its members.
public class MyClass1
{
    [MyAttribute("This is an example attribute.")]
    public void MyMethod(int i)
    {
        return;
    }
}

public class MemberInfo_GetCustomAttributes
{
    public static void Main()
    {
        try
        {
            // Get the type of MyClass1.
            Type myType = typeof(MyClass1);
            // Get the members associated with MyClass1.
            MemberInfo[] myMembers = myType.GetMembers();

            // Display the attributes for each of the members of MyClass1.
            for(int i = 0; i < myMembers.Length; i++)
            {
                Object[] myAttributes = myMembers[i].GetCustomAttributes(true);
                if(myAttributes.Length > 0)
                {
                    Console.WriteLine("\nThe attributes for the member {0} are: \n", myMembers[i]);
                    for(int j = 0; j < myAttributes.Length; j++)
                        Console.WriteLine("The type of the attribute is {0}.", myAttributes[j]);
                }
            }
        }
        catch(Exception e)
        {
            Console.WriteLine("An exception occurred: {0}", e.Message);
        }
    }
}
Imports System.Reflection

' Define a custom attribute with one named parameter.
<AttributeUsage(AttributeTargets.All)> Public Class MyAttribute
    Inherits Attribute
    Private myName As String

    Public Sub New(ByVal name As String)
        myName = name
    End Sub 'New

    Public ReadOnly Property Name() As String
        Get
            Return myName
        End Get
    End Property
End Class 'MyAttribute

' Define a class that has the custom attribute associated with one of its members.
Public Class MyClass1

    <MyAttribute("This is an example attribute.")> Public Sub MyMethod(ByVal i As Integer)
        Return
    End Sub 'MyMethod
End Class 'MyClass1


Public Class MemberInfo_GetCustomAttributes

    Public Shared Sub Main()
        Try
            ' Get the type of MyClass1.
            Dim myType As Type = GetType(MyClass1)
            ' Get the members associated with MyClass1.
            Dim myMembers As MemberInfo() = myType.GetMembers()

            ' Display the attributes for each of the members of MyClass1.
            Dim i As Integer
            For i = 0 To myMembers.Length - 1
                Dim myAttributes As [Object]() = myMembers(i).GetCustomAttributes(False)
                If myAttributes.Length > 0 Then
                    Console.WriteLine("The attributes for the member {0} are: ", myMembers(i))
                    Dim j As Integer
                    For j = 0 To myAttributes.Length - 1
                        Console.WriteLine("The type of the attribute is: {0}", myAttributes(j))
                    Next j
                End If
            Next i
        Catch e As Exception
            Console.WriteLine("An exception occurred: {0}.", e.Message)
        End Try
    End Sub 'Main
End Class 'MemberInfo_GetCustomAttributes

Hinweise

Diese Methode ignoriert den inherit -Parameter für Eigenschaften und Ereignisse.This method ignores the inherit parameter for properties and events. Um die Vererbungs Kette nach Attributen für Eigenschaften und Ereignisse zu durchsuchen, verwenden Sie die entsprechenden Attribute.GetCustomAttributes über Ladungen der-Methode.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Hinweis

In der .NET Framework Version 2,0 gibt diese Methode Sicherheits Attribute für Methoden, Konstruktoren und Typen zurück, wenn Sie im neuen Metadatenformat gespeichert werden.In the .NET Framework version 2.0, this method returns security attributes on methods, constructors, and types if they are stored in the new metadata format. Mit Version 2,0 kompilierte Assemblys verwenden dieses Format.Assemblies compiled with version 2.0 use this format. Dynamische Assemblys und Assemblys, die mit früheren Versionen der .NET Framework kompiliert wurden, verwenden das alte XML-FormatDynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Siehe Ausgeben von deklarativen Sicherheits Attributen.See Emitting Declarative Security Attributes.

Siehe auch

GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean) GetCustomAttributes(Type, Boolean)

Gibt beim Überschreiben in einer abgeleiteten Klasse ein Array aus benutzerdefinierten Attributen zurück, die auf diesen Member angewendet und von Type identifiziert wurden.When overridden in a derived class, returns an array of custom attributes applied to this member and identified by Type.

public:
 abstract cli::array <System::Object ^> ^ GetCustomAttributes(Type ^ attributeType, bool inherit);
public abstract object[] GetCustomAttributes (Type attributeType, bool inherit);
abstract member GetCustomAttributes : Type * bool -> obj[]
Public MustOverride Function GetCustomAttributes (attributeType As Type, inherit As Boolean) As Object()

Parameter

attributeType
Type Type Type Type

Der Typ des zu suchenden Attributs.The type of attribute to search for. Nur Attribute, die diesem Typ zugeordnet werden können, werden zurückgegeben.Only attributes that are assignable to this type are returned.

inherit
Boolean Boolean Boolean Boolean

true, um die Vererbungskette dieses Members nach den Attributen zu durchsuchen; andernfalls false.true to search this member's inheritance chain to find the attributes; otherwise, false. Dieser Parameter wird für Eigenschaften und Ereignisse ignoriert.This parameter is ignored for properties and events.

Gibt zurück

Object[]

Ein Array aus benutzerdefinierten Attributen, die auf diesen Member angewendet wurden, oder ein Array mit 0 (null) Elementen, wenn keine Attribute angewendet wurden, die attributeType zugewiesen werden können.An array of custom attributes applied to this member, or an array with zero elements if no attributes assignable to attributeType have been applied.

Implementiert

Ausnahmen

Ein benutzerdefinierter Attributtyp kann nicht geladen werden.A custom attribute type cannot be loaded.

Wenn attributeType gleich null ist.If attributeType is null.

Dieser Member gehört zu einem Typ, der in den auf Reflexionen beschränkten Kontext geladen wird.This member belongs to a type that is loaded into the reflection-only context. Weitere Informationen finden Sie unter Vorgehensweise: Laden von Assemblys in den reflexionsbezogenen Kontext.See How to: Load Assemblies into the Reflection-Only Context.

Beispiele

Im folgenden Beispiel wird eine Klasse mit BaseClass dem Namen definiert, die zwei nicht geerbte Member hat: ein total statisches Feld mit dem Namen und eine nicht CLS-kompatible Methode mit dem Namen MethodA.The following example defines a class named BaseClass that has two non-inherited members: a thread static field named total and a non-CLS-compliant method named MethodA. Eine Klasse mit DerivedClass dem Namen erbt von BaseClass und über MethodA schreibt die-Methode.A class named DerivedClass inherits from BaseClass and overrides its MethodA method. Beachten Sie, dass auf die Member von DerivedClasskeine Attribute angewendet werden.Note that no attributes are applied to the members of DerivedClass. Im Beispiel werden die Member von durch DerivedClass laufen, um zu CLSCompliantAttribute bestimmen ThreadStaticAttribute , ob das-Attribut oder das-Attribut darauf angewendet wurde.The example iterates the members of DerivedClass to determine whether the CLSCompliantAttribute or ThreadStaticAttribute attribute as been applied to them. Da inherit DerivedClass ist true, durchsucht die-Methode die Vererbungs Hierarchie von nach dem angegebenen Attribut.Because inherit is true, the method searches the inheritance hierarchy of DerivedClass for the specified attribute. Wie die Ausgabe des Beispiels zeigt, wird das total -Feld mit dem ThreadStaticAttribute -Attribut versehen, und MethodA die-Methode wird mit CLSCompliantAttribute dem-Attribut ergänzt.As the output from the example shows, the total field is decorated with the ThreadStaticAttribute attribute, and the MethodA method is decorated with the CLSCompliantAttribute attribute.

using System;

public class BaseClass
{
   [ThreadStatic] public int total;
   
   [CLSCompliant(false)] public virtual uint MethodA()
   {
      return (uint) 100;
   }
}

public class DerivedClass : BaseClass
{
   public override uint MethodA()
   {
      total++;
      return 200;
   }
}

public class Example
{
   public static void Main()
   {
      Type t = typeof(DerivedClass);
      Console.WriteLine("Members of {0}:", t.FullName);
      foreach (var m in t.GetMembers())
      {
         bool hasAttribute = false;
         Console.Write("   {0}: ", m.Name);
         if (m.GetCustomAttributes(typeof(CLSCompliantAttribute), true).Length > 0) {
            Console.Write("CLSCompliant");
            hasAttribute = true;
         }
         if (m.GetCustomAttributes(typeof(ThreadStaticAttribute), true).Length > 0) {
            Console.Write("ThreadStatic");
            hasAttribute = true;
         }
         if (! hasAttribute)
            Console.Write("No attributes");

         Console.WriteLine();
      }
   }
}
// The example displays the following output:
//       Members of DerivedClass:
//          MethodA: CLSCompliant
//          ToString: No attributes
//          Equals: No attributes
//          GetHashCode: No attributes
//          typeof: No attributes
//          .ctor: No attributes
//          total: ThreadStatic
Public Class BaseClass
   <ThreadStatic> Public total As Integer
   
   <CLSCompliant(False)> Public Overridable Function MethodA() As UInt32
      Return CUInt(100)
   End Function
End Class

Public Class DerivedClass : Inherits BaseClass
   Public Overrides Function MethodA() As UInt32
      total += 1
      Return 200
   End Function
End Class

Module Example
   Public Sub Main()
      Dim t As Type = GetType(DerivedClass)
      Console.WriteLine("Members of {0}:", t.FullName)
      For Each m In t.GetMembers()
         Dim hasAttribute As Boolean = False
         Console.Write("   {0}: ", m.Name)
         If m.GetCustomAttributes(GetType(CLSCompliantAttribute), True).Length > 0 Then
            Console.Write("CLSCompliant")
            hasAttribute = True
         End If
         If m.GetCustomAttributes(GetType(ThreadStaticAttribute), True).Length > 0 Then
            Console.Write("ThreadStatic")
            hasAttribute = True
         End If
         If Not hasAttribute Then
            Console.Write("No attributes")
         End If
         Console.WriteLine()
      Next
   End Sub
End Module
' The example displays the following output:
'       Members of DerivedClass:
'          MethodA: CLSCompliant
'          ToString: No attributes
'          Equals: No attributes
'          GetHashCode: No attributes
'          GetType: No attributes
'          .ctor: No attributes
'          total: ThreadStatic

Hinweise

Diese Methode ignoriert den inherit -Parameter für Eigenschaften und Ereignisse.This method ignores the inherit parameter for properties and events. Um die Vererbungs Kette nach Attributen für Eigenschaften und Ereignisse zu durchsuchen, verwenden Sie die entsprechenden Attribute.GetCustomAttributes über Ladungen der-Methode.To search the inheritance chain for attributes on properties and events, use the appropriate overloads of the Attribute.GetCustomAttributes method.

Hinweis

In der .NET Framework Version 2,0 gibt diese Methode Sicherheits Attribute für Methoden, Konstruktoren und Typen zurück, wenn die Attribute im neuen Metadatenformat gespeichert werden.In the .NET Framework version 2.0, this method returns security attributes on methods, constructors, and types if the attributes are stored in the new metadata format. Mit Version 2,0 kompilierte Assemblys verwenden dieses Format.Assemblies compiled with version 2.0 use this format. Dynamische Assemblys und Assemblys, die mit früheren Versionen der .NET Framework kompiliert wurden, verwenden das alte XML-FormatDynamic assemblies and assemblies compiled with earlier versions of the .NET Framework use the old XML format. Siehe Ausgeben von deklarativen Sicherheits Attributen.See Emitting Declarative Security Attributes.

Gilt für: