내보내기(0) 인쇄
모두 확장

Attribute.GetCustomAttribute 메서드 (ParameterInfo, Type, Boolean)

업데이트: 2007년 11월

메서드 매개 변수에 적용된 사용자 지정 특성을 검색합니다. 매개 변수에는 메서드 매개 변수, 검색할 사용자 지정 특성 형식 및 상위 메서드 매개 변수의 검색 여부를 지정합니다.

네임스페이스:  System
어셈블리:  mscorlib(mscorlib.dll)

public static Attribute GetCustomAttribute(
	ParameterInfo element,
	Type attributeType,
	bool inherit
)
public static Attribute GetCustomAttribute(
	ParameterInfo element,
	Type attributeType,
	boolean inherit
)
public static function GetCustomAttribute(
	element : ParameterInfo, 
	attributeType : Type, 
	inherit : boolean
) : Attribute

매개 변수

element
형식: System.Reflection.ParameterInfo
클래스의 멤버 매개 변수를 설명하는 ParameterInfo 클래스에서 파생된 개체입니다.
attributeType
형식: System.Type
검색할 사용자 지정 특성의 형식, 즉 기본 형식입니다.
inherit
형식: System.Boolean
true이면 사용자 지정 특성에 대한 상위 element도 검색함을 지정합니다.

반환 값

형식: System.Attribute
element에 적용된 attributeType 형식의 단일 사용자 지정 특성에 대한 참조입니다. 그러한 특성이 없는 경우에는 null입니다.

예외상황
ArgumentNullException

element 또는 attributeTypenull인 경우

ArgumentException

attributeTypeAttribute에서 파생되지 않은 경우

AmbiguousMatchException

요청된 특성이 둘 이상 발견된 경우

TypeLoadException

사용자 지정 특성 형식을 로드할 수 없는 경우

element가 파생 형식의 메서드에 있는 매개 변수를 나타내는 경우 재정의된 기본 메서드에 있는 같은 매개 변수에 적용된 상속 가능한 사용자 지정 특성이 반환 값에 포함됩니다.

다음 코드 예제에서는 사용자 지정 매개 변수 Attribute 클래스를 정의하고 사용자 지정 특성을 파생 클래스 및 해당 기본 클래스의 메서드에 적용합니다. 다음 예제에서는 GetCustomAttribute 메서드를 사용하여 특성을 반환하는 방법을 보여 줍니다.

// Example for the Attribute.GetCustomAttribute( ParameterInfo, Type, Boolean ) 
// 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( Parameter" +
                "Info, Type, Boolean )\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) 
            {
                DisplayParameterAttributes( mInfo, pInfoArray, false );
                DisplayParameterAttributes( mInfo, pInfoArray, true );
            }
            else
                Console.WriteLine("The parameters information could " +
                    "not be retrieved for method {0}.", mInfo.Name);
        }

        static void DisplayParameterAttributes( MethodInfo mInfo,
            ParameterInfo[] pInfoArray, bool includeInherited )
        {
            Console.WriteLine( 
                "\nParameter attribute information for method \"" +
                "{0}\"\nincludes inheritance from base class: {1}.", 
                mInfo.Name, includeInherited ? "Yes" : "No" );

            // Display the attribute information for the parameters.
            foreach( ParameterInfo paramInfo in pInfoArray )
            {
                // See if the ParamArray attribute is defined.
                bool isDef = Attribute.IsDefined( paramInfo, 
                    typeof(ParamArrayAttribute));

                if( isDef )
                    Console.WriteLine(
                        "\n    The ParamArray attribute is defined " +
                        "for \n    parameter {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),
                        includeInherited );

                if( usageAttr != null )
                {
                    Console.WriteLine( 
                        "\n    The ArgumentUsage attribute is def" +
                        "ined for \n    parameter {0} of method {1}.",
                        paramInfo.Name, mInfo.Name );

                    Console.WriteLine( "\n        The usage " +
                        "message for {0} is:\n        \"{1}\".",
                        paramInfo.Name, usageAttr.Message);
                }
            }
        }
    }
}

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

Parameter attribute information for method "TestMethod"
includes inheritance from base class: No.

    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.".

Parameter attribute information for method "TestMethod"
includes inheritance from base class: Yes.

    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.".
*/


// Example for the Attribute.GetCustomAttribute( ParameterInfo, Type, Boolean )
// method.
package NDP_UE_JSL; 

import System.*;
import System.Reflection.*;

// Define a custom parameter attribute that takes a single message argument.
/** @attribute AttributeUsage(AttributeTargets.Parameter)
 */
public class ArgumentUsageAttribute extends Attribute
{
    // This is the attribute constructor.
    public ArgumentUsageAttribute(String usgMsg)
    {
        this.usageMsg = usgMsg;
    } //ArgumentUsageAttribute

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

    // This is the Message property for the attribute.
    /** @property 
     */
    public String get_Message()
    {
        return usageMsg;
    }//get_Message

    /** @property 
     */
    public void set_Message(String value)
    {
        usageMsg = value;
    }//set_Message
} //ArgumentUsageAttribute  

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

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

class CustomParamDemo
{
    public static void main(String[] args)
    {
        Console.WriteLine(("This example of Attribute.GetCustomAttribute( "
            + "ParameterInfo, Type, Boolean )\n"
            + "generates the following output."));

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

        // Iterate through the ParameterInfo array for the method parameters.
        ParameterInfo pInfoArray[] = mInfo.GetParameters();
        if (pInfoArray != null)    {
            DisplayParameterAttributes(mInfo, pInfoArray, false);
            DisplayParameterAttributes(mInfo, pInfoArray, true);
        }
        else {
            Console.WriteLine("The parameters information could " 
                + "not be retrieved for method {0}.", mInfo.get_Name());
        }
    } //main

    static void DisplayParameterAttributes(MethodInfo mInfo,
        ParameterInfo pInfoArray[], boolean includeInherited)
    {
        Console.WriteLine("\nParameter attribute information for method \"" 
            + "{0}\"\nincludes inheritance from base class: {1}.",
            mInfo.get_Name(), (includeInherited) ? "Yes" : "No");
        for (int iCtr = 0; iCtr < pInfoArray.length; iCtr++) {
            // Display the attribute information for the parameters.
            ParameterInfo paramInfo = pInfoArray[iCtr];
            // See if the ParamArray attribute is defined.
            boolean isDef = Attribute.IsDefined(paramInfo, 
                ParamArrayAttribute.class.ToType());
            if (isDef) {
                Console.WriteLine("\n    The ParamArray attribute is defined " 
                    + "for \n    parameter {0} of method {1}.", 
                    paramInfo.get_Name(), mInfo.get_Name());
            }

            // See if ParamUsageAttribute is defined.  
            // If so, display a message.
            ArgumentUsageAttribute usageAttr = ((ArgumentUsageAttribute)
                (Attribute.GetCustomAttribute(paramInfo, 
                ArgumentUsageAttribute.class.ToType(), includeInherited)));
            if (usageAttr != null) {
                Console.WriteLine("\n    The ArgumentUsage attribute is " 
                    + "defined for \n    parameter {0} of method {1}.", 
                    paramInfo.get_Name(), mInfo.get_Name());
                Console.WriteLine("\n        The usage message for " 
                    + "{0} is:\n        \"{1}\".", paramInfo.get_Name(),
                    usageAttr.get_Message());
            }
        }
    } //DisplayParameterAttributes
} //CustomParamDemo

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

Parameter attribute information for method "TestMethod"
includes inheritance from base class: No.

    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.".

Parameter attribute information for method "TestMethod"
includes inheritance from base class: Yes.

    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.".
*/


Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360

.NET Framework 및 .NET Compact Framework에서 모든 플랫폼의 전체 버전을 지원하지는 않습니다. 지원되는 버전의 목록을 보려면 .NET Framework 시스템 요구 사항을 참조하십시오.

.NET Framework

3.5, 3.0, 2.0, 1.1, 1.0에서 지원

.NET Compact Framework

3.5, 2.0, 1.0에서 지원

XNA Framework

2.0, 1.0에서 지원

커뮤니티 추가 항목

추가
표시:
© 2014 Microsoft