Partager via


ParameterInfo.GetCustomAttributes Méthode

Définition

Obtient les attributs personnalisés appliqués à ce paramètre.

Surcharges

GetCustomAttributes(Type, Boolean)

Obtient les attributs personnalisés du type spécifié ou de ses types dérivés qui sont appliqués à ce paramètre.

GetCustomAttributes(Boolean)

Obtient tous les attributs personnalisés définis sur ce paramètre.

GetCustomAttributes(Type, Boolean)

Source:
ParameterInfo.cs
Source:
ParameterInfo.cs
Source:
ParameterInfo.cs

Obtient les attributs personnalisés du type spécifié ou de ses types dérivés qui sont appliqués à ce paramètre.

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()

Paramètres

attributeType
Type

Attributs personnalisés identifiés par type.

inherit
Boolean

Cet argument est ignoré pour les objets de ce type.

Retours

Object[]

Tableau qui contient les attributs personnalisés du type spécifié ou de ses types dérivés.

Implémente

Exceptions

Le type doit être un type fourni par le système runtime sous-jacent.

attributeType a la valeur null.

Un type d'attribut personnalisé ne peut pas être chargé.

Remarques

Cette méthode ignore le inherit paramètre. Pour rechercher des attributs sur des paramètres dans la chaîne d’héritage, utilisez les surcharges appropriées de la Attribute.GetCustomAttributes méthode.

S’applique à

GetCustomAttributes(Boolean)

Source:
ParameterInfo.cs
Source:
ParameterInfo.cs
Source:
ParameterInfo.cs

Obtient tous les attributs personnalisés définis sur ce paramètre.

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()

Paramètres

inherit
Boolean

Cet argument est ignoré pour les objets de ce type.

Retours

Object[]

Tableau qui contient tous les attributs personnalisés appliqués à ce paramètre.

Implémente

Exceptions

Un type d'attribut personnalisé ne peut pas être chargé.

Exemples

L’exemple suivant montre comment les attributs personnalisés qui ont été appliqués aux paramètres des méthodes peuvent être récupérés au moment de l’exécution. L’exemple définit un attribut personnalisé nommé MyAttribute qui peut être appliqué aux paramètres. L’exemple définit ensuite une classe nommée MyClass avec une méthode nommée MyMethodet s’applique MyAttribute à un paramètre de la méthode.

Lorsque l’exemple est exécuté, il utilise la GetCustomAttributes(Boolean) méthode pour récupérer les attributs personnalisés qui ont été appliqués à tous les paramètres de toutes les méthodes dans MyClass, et les affiche dans la console.

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 :

Remarques

Cette méthode ignore le inherit paramètre. Pour rechercher des attributs sur des paramètres dans la chaîne d’héritage, utilisez les surcharges appropriées de la Attribute.GetCustomAttributes méthode.

S’applique à