Freigeben über


ParameterInfo.GetCustomAttributes Methode

Definition

Ruft die benutzerdefinierten Attribute ab, die auf diesen Parameter angewendet werden.

Überlädt

GetCustomAttributes(Type, Boolean)

Ruft die benutzerdefinierten Attribute vom angegebenen Typ oder von abgeleiteten Typen ab, die auf diesen Parameter angewendet werden.

GetCustomAttributes(Boolean)

Ruft alle benutzerdefinierten Attribute ab, die für diesen Parameter definiert sind.

GetCustomAttributes(Type, Boolean)

Quelle:
ParameterInfo.cs
Quelle:
ParameterInfo.cs
Quelle:
ParameterInfo.cs

Ruft die benutzerdefinierten Attribute vom angegebenen Typ oder von abgeleiteten Typen ab, die auf diesen Parameter angewendet werden.

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

Parameter

attributeType
Type

Die nach Typ identifizierten benutzerdefinierten Attribute.

inherit
Boolean

Dieses Argument wird für Objekte dieses Typs ignoriert.

Gibt zurück

Object[]

Ein Array, das die benutzerdefinierten Attribute vom angegebenen Typ oder von abgeleiteten Typen enthält.

Implementiert

Ausnahmen

Der Typ muss ein vom zugrunde liegenden Laufzeitsystem bereitgestellter Typ sein.

attributeType ist null.

Ein benutzerdefinierter Attributtyp konnte nicht geladen werden.

Hinweise

Diese Methode ignoriert den inherit Parameter. Um die Vererbungskette nach Attributen für Parameter zu durchsuchen, verwenden Sie die entsprechenden Überladungen der Attribute.GetCustomAttributes Methode.

Gilt für:

GetCustomAttributes(Boolean)

Quelle:
ParameterInfo.cs
Quelle:
ParameterInfo.cs
Quelle:
ParameterInfo.cs

Ruft alle benutzerdefinierten Attribute ab, die für diesen Parameter definiert sind.

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

Parameter

inherit
Boolean

Dieses Argument wird für Objekte dieses Typs ignoriert.

Gibt zurück

Object[]

Ein Array, das alle auf diesen Parameter angewendeten benutzerdefinierten Attribute enthält.

Implementiert

Ausnahmen

Ein benutzerdefinierter Attributtyp konnte nicht geladen werden.

Beispiele

Das folgende Beispiel zeigt, wie benutzerdefinierte Attribute, die auf die Parameter von Methoden angewendet wurden, zur Laufzeit abgerufen werden können. Im Beispiel wird ein benutzerdefiniertes Attribut mit dem Namen definiert MyAttribute , das auf Parameter angewendet werden kann. Das Beispiel definiert dann eine Klasse mit dem Namen MyClass einer Methode namens MyMethodund gilt für MyAttribute einen Parameter der -Methode.

Wenn das Beispiel ausgeführt wird, wird die GetCustomAttributes(Boolean) -Methode verwendet, um die benutzerdefinierten Attribute abzurufen, die auf alle Parameter aller Methoden in MyClassangewendet wurden, und zeigt sie in der Konsole an.

using namespace System;
using namespace System::Reflection;

// Define a custom attribute with one named parameter.
[AttributeUsage(AttributeTargets::Parameter)]
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 which has a custom attribute associated with one of the 
// parameters of a method. 
public ref class MyClass1
{
public:
   void MyMethod( 
      [MyAttribute("This is an example parameter attribute")]
      int i ) {}
};

void main()
{
   // Get the type of the class 'MyClass1'.
   Type^ myType = MyClass1::typeid;

   // Get the members associated with the class 'MyClass1'.
   array<MethodInfo^>^myMethods = myType->GetMethods();

   // Display the attributes for each of the parameters of each method of the class 'MyClass1'.
   for ( int i = 0; i < myMethods->Length; i++ )
   {
      // Get the parameters for the method.
      array<ParameterInfo^>^myParameters = myMethods[ i ]->GetParameters();

      if ( myParameters->Length > 0 )
      {
         Console::WriteLine( "\nThe parameters for the method \"{0}\" that have custom attributes are:", myMethods[ i ] );
         for ( int j = 0; j < myParameters->Length; j++ )
         {
            // Get the attributes of type 'MyAttribute' for each parameter.
            array<Object^>^myAttributes = myParameters[ j ]->GetCustomAttributes( MyAttribute::typeid, false );

            if ( myAttributes->Length > 0 )
            {
               Console::WriteLine( "Parameter {0}, name = {1}, type = {2} has attributes:",
                  myParameters[ j ]->Position, 
                  myParameters[ j ]->Name, 
                  myParameters[ j ]->ParameterType );
               for ( int k = 0; k < myAttributes->Length; k++ )
               {
                  Console::WriteLine( "\t{0}", myAttributes[ k ] );
               }
            }
         }
      }
   }
}
/* This code example produces the following output:

The parameters for the method Void MyMethod(Int32) that have custom attributes are :
Parameter 0, name = i, type = System.Int32 has attributes:
        MyAttribute

The parameters for the method Boolean Equals(System.Object) that have custom attributes are :
 */
using System;
using System.Reflection;

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

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

public class MemberInfo_GetCustomAttributes
{
    public static void Main()
    {
        // Get the type of the class 'MyClass1'.
        Type myType = typeof(MyClass1);
        // Get the members associated with the class 'MyClass1'.
        MethodInfo[] myMethods = myType.GetMethods();

        // Display the attributes for each of the parameters of each method of the class 'MyClass1'.
        for(int i = 0; i < myMethods.Length; i++)
        {
            // Get the parameters for the method.
            ParameterInfo[] myParameters = myMethods[i].GetParameters();

            if (myParameters.Length > 0)
            {
                Console.WriteLine("\nThe parameters for the method {0} that have custom attributes are :", myMethods[i]);
                for(int j = 0; j < myParameters.Length; j++)
                {
                    // Get the attributes of type 'MyAttribute' for each parameter.
                    Object[] myAttributes = myParameters[j].GetCustomAttributes(typeof(MyAttribute), false);

                    if (myAttributes.Length > 0)
                    {
                        Console.WriteLine("Parameter {0}, name = {1}, type = {2} has attributes: ",
                            myParameters[j].Position, myParameters[j].Name, myParameters[j].ParameterType);
                        for(int k = 0; k < myAttributes.Length; k++)
                        {
                            Console.WriteLine("\t{0}", myAttributes[k]);
                        }
                    }
                }
            }
        }
    }
}
/* This code example produces the following output:

The parameters for the method Void MyMethod(Int32) that have custom attributes are :
Parameter 0, name = i, type = System.Int32 has attributes:
        MyAttribute

The parameters for the method Boolean Equals(System.Object) that have custom attributes are :
 */
Imports System.Reflection

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

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

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

' Define a class which has a custom attribute associated with one of 
' the parameters of a method. 
Public Class MyClass1

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


Public Class MemberInfo_GetCustomAttributes

    Public Shared Sub Main()
        ' Get the type of the class 'MyClass1'.
        Dim myType As Type = GetType(MyClass1)
        ' Get the members associated with the class 'MyClass1'.
        Dim myMethods As MethodInfo() = myType.GetMethods()

        ' Display the attributes for each of the parameters of each method of the class 'MyClass1'.
        For i As Integer = 0 To myMethods.Length - 1
            ' Get the parameters for the method.
            Dim myParameters As ParameterInfo() = myMethods(i).GetParameters()

            If myParameters.Length > 0 Then
                Console.WriteLine(vbCrLf & "The parameters for the method {0} that have custom attributes are : ", myMethods(i))
                For j As Integer = 0 To myParameters.Length - 1
                    ' Get the attributes of type 'MyAttribute' for each parameter.
                    Dim myAttributes As Object() = myParameters(j).GetCustomAttributes(GetType(MyAttribute), False)

                    If myAttributes.Length > 0 Then
                        Console.WriteLine("Parameter {0}, name = {1}, type = {2} has attributes: ", _
                            myParameters(j).Position, myParameters(j).Name, myParameters(j).ParameterType)
                        For k As Integer = 0 To myAttributes.Length - 1
                            Console.WriteLine(vbTab & "{0}", myAttributes(k))
                        Next k
                    End If
                Next j
            End If
        Next i
    End Sub 
End Class 

' This code example produces the following output:
'
'The parameters for the method Void MyMethod(Int32) that have custom attributes are :
'Parameter 0, name = i, type = System.Int32 has attributes:
'        MyAttribute
'
'The parameters for the method Boolean Equals(System.Object) that have custom attributes are :

Hinweise

Diese Methode ignoriert den inherit Parameter. Um die Vererbungskette nach Attributen für Parameter zu durchsuchen, verwenden Sie die entsprechenden Überladungen der Attribute.GetCustomAttributes Methode.

Gilt für: