ParameterInfo.GetCustomAttributes Método

Definição

Namespace:

System.Reflection

Assemblies:

netstandard.dll, System.Runtime.dll

Obtém os atributos personalizados aplicados a este parâmetro.

Sobrecargas

Nome	Description
GetCustomAttributes(Type, Boolean)	Obtém os atributos personalizados do tipo especificado ou seus tipos derivados que são aplicados a esse parâmetro.
GetCustomAttributes(Boolean)	Obtém todos os atributos personalizados definidos nesse parâmetro.

GetCustomAttributes(Type, Boolean)

Origem:

ParameterInfo.cs

Obtém os atributos personalizados do tipo especificado ou seus tipos derivados que são aplicados a esse parâmetro.

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

Parâmetros

attributeType

Type

Os atributos personalizados identificados por tipo.

inherit

Boolean

Este argumento é ignorado para objetos deste tipo.

Retornos

Object[]

Uma matriz que contém os atributos personalizados do tipo especificado ou seus tipos derivados.

Implementações

GetCustomAttributes(Type, Boolean)

Exceções

ArgumentException

O tipo deve ser um tipo fornecido pelo sistema de runtime subjacente.

ArgumentNullException

attributeType é null.

TypeLoadException

Um tipo de atributo personalizado não pôde ser carregado.

Comentários

Esse método ignora o inherit parâmetro . Para pesquisar atributos na cadeia de herança em parâmetros, use as sobrecargas apropriadas do Attribute.GetCustomAttributes método .

GetCustomAttributes(Boolean)

Origem:

ParameterInfo.cs

Obtém todos os atributos personalizados definidos nesse parâmetro.

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

Parâmetros

inherit

Boolean

Este argumento é ignorado para objetos deste tipo.

Retornos

Object[]

Uma matriz que contém todos os atributos personalizados aplicados a esse parâmetro.

Implementações

GetCustomAttributes(Boolean)

Exceções

TypeLoadException

Um tipo de atributo personalizado não pôde ser carregado.

Exemplos

O exemplo a seguir mostra como atributos personalizados que foram aplicados aos parâmetros dos métodos podem ser recuperados em tempo de execução. O exemplo define um atributo personalizado chamado MyAttribute que pode ser aplicado a parâmetros. Em seguida, o exemplo define uma classe chamada MyClass com um método chamado MyMethode se aplica MyAttribute a um parâmetro do método .

Quando o exemplo é executado, ele usa o GetCustomAttributes(Boolean) método para recuperar os atributos personalizados que foram aplicados a todos os parâmetros de todos os métodos no MyClasse os exibe no console.

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 :

Comentários

Esse método ignora o inherit parâmetro . Para pesquisar atributos na cadeia de herança em parâmetros, use as sobrecargas apropriadas do Attribute.GetCustomAttributes método .