Dieser Artikel wurde maschinell übersetzt. Wenn Sie die englische Version des Artikels anzeigen möchten, aktivieren Sie das Kontrollkästchen Englisch. Sie können den englischen Text auch in einem Popupfenster anzeigen, indem Sie den Mauszeiger über den Text bewegen.
Übersetzung
Englisch

Attribute.GetCustomAttribute-Methode: (ParameterInfo, Type)

 

Veröffentlicht: Oktober 2016

Ruft ein benutzerdefiniertes Attribut auf einen Methodenparameter angewendet. Parameter geben die Methodenparameter und den Typ des zu suchenden Attributs.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

public static Attribute GetCustomAttribute(
	ParameterInfo element,
	Type attributeType
)

Parameter

element
Type: System.Reflection.ParameterInfo

Ein abgeleitetes Objekt aus der ParameterInfo -Klasse, die einen Parameter eines Members einer Klasse beschreibt.

attributeType
Type: System.Type

Der Typ oder ein Basistyp des benutzerdefinierten Attributs gesucht.

Rückgabewert

Type: System.Attribute

Ein Verweis auf das einzige benutzerdefinierte Attribut vom Typ attributeType angewendeten element, oder null , wenn kein solches Attribut vorhanden ist.

Exception Condition
ArgumentNullException

element oder attributeType ist null.

ArgumentException

attributeTypestammt nicht aus Attribute.

AmbiguousMatchException

Mehr als eine der erforderlichen Attribute gefunden.

TypeLoadException

Ein benutzerdefinierter Attributtyp kann nicht geladen werden.

Wenn element stellt einen Parameter in einer Methode dar, der ein abgeleiteter Typ, der Rückgabewert enthält die vererbbaren benutzerdefinierten Attribute, die auf den gleichen Parameter in der überschriebenen Basismethoden angewendet.

Das folgende Codebeispiel definiert einen benutzerdefinierten Parameter Attribute Klasse und das benutzerdefinierte Attribut an eine Methode in einer abgeleiteten Klasse und die Basis der abgeleiteten Klasse angewendet. Das Beispiel zeigt die Verwendung der GetCustomAttribute Methode, um die Attribute zurückzugeben.

// Example for the Attribute.GetCustomAttribute( ParameterInfo, Type ) method.
using System;
using System.Reflection;

namespace NDP_UE_CS 
{
    // Define a custom parameter attribute that takes a single message argument.
    [AttributeUsage( AttributeTargets.Parameter )]
    public class ArgumentUsageAttribute : Attribute
    {
        // This is the attribute constructor.
        public ArgumentUsageAttribute( string UsageMsg )
        {
            this.usageMsg = UsageMsg;
        }

        // usageMsg is storage for the attribute message.
        protected string usageMsg;

        // This is the Message property for the attribute.
        public string Message
        {
            get { return usageMsg; }
            set { usageMsg = value; }
        }
    }

    public class BaseClass 
    {
        // Assign an ArgumentUsage attribute to the strArray parameter.
        // Assign a ParamArray attribute to strList using the params keyword.
        public virtual void TestMethod(
            [ArgumentUsage("Must pass an array here.")]
            String[] strArray,
            params String[] strList)
        { }
    }

    public class DerivedClass : BaseClass
    {
        // Assign an ArgumentUsage attribute to the strList parameter.
        // Assign a ParamArray attribute to strList using the params keyword.
        public override void TestMethod(
            String[] strArray,
            [ArgumentUsage("Can pass a parameter list or array here.")]
            params String[] strList)
        { }
    }

    class CustomParamDemo 
    {
        static void Main( ) 
        {
            Console.WriteLine( 
                "This example of Attribute.GetCustomAttribute( Param" +
                "eterInfo, Type )\ngenerates the following output." );

            // Get the class type, and then get the MethodInfo object 
            // for TestMethod to access its metadata.
            Type clsType = typeof( DerivedClass );
            MethodInfo mInfo = clsType.GetMethod("TestMethod");

            // Iterate through the ParameterInfo array for the method parameters.
            ParameterInfo[] pInfoArray = mInfo.GetParameters();
            if (pInfoArray != null) 
            {
                foreach( ParameterInfo paramInfo in pInfoArray )
                {
                    // See if the ParamArray attribute is defined.
                    bool isDef = Attribute.IsDefined( 
                        paramInfo, typeof(ParamArrayAttribute));

                    if( isDef )
                        Console.WriteLine( 
                            "\nThe ParamArray attribute is defined " +
                            "for \nparameter {0} of method {1}.",
                            paramInfo.Name, mInfo.Name);

                    // See if ParamUsageAttribute is defined.  
                    // If so, display a message.
                    ArgumentUsageAttribute usageAttr = (ArgumentUsageAttribute)
                        Attribute.GetCustomAttribute( 
                            paramInfo, typeof(ArgumentUsageAttribute) );

                    if( usageAttr != null )
                    {
                        Console.WriteLine( 
                            "\nThe ArgumentUsage attribute is defined " +
                            "for \nparameter {0} of method {1}.",
                            paramInfo.Name, mInfo.Name );

                        Console.WriteLine( "\n    The usage " +
                            "message for {0} is:\n    \"{1}\".",
                            paramInfo.Name, usageAttr.Message);
                    }
                }
            }
            else
                Console.WriteLine( 
                    "The parameters information could not " +
                    "be retrieved for method {0}.", mInfo.Name);
        }
    }
}

/*
This example of Attribute.GetCustomAttribute( ParameterInfo, Type )
generates the following output.

The ArgumentUsage attribute is defined for
parameter strArray of method TestMethod.

    The usage message for strArray is:
    "Must pass an array here.".

The ParamArray attribute is defined for
parameter strList of method TestMethod.

The ArgumentUsage attribute is defined for
parameter strList of method TestMethod.

    The usage message for strList is:
    "Can pass a parameter list or array here.".
*/

.NET Framework
Verfügbar seit 1.1
Portierbare Klassenbibliothek
Unterstützt in: portierbare .NET-Plattformen
Silverlight
Verfügbar seit 2.0
Windows Phone Silverlight
Verfügbar seit 7.0
Zurück zum Anfang
Anzeigen: