This documentation is archived and is not being maintained.
Attribute::GetCustomAttributes Method (ParameterInfo, Type)
Visual Studio 2010
Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for.
Assembly: mscorlib (in mscorlib.dll)
public: static array<Attribute^>^ GetCustomAttributes( ParameterInfo^ element, Type^ attributeType )
Parameters
- element
- Type: System.Reflection::ParameterInfo
An object derived from the ParameterInfo class that describes a parameter of a member of a class.
- attributeType
- Type: System::Type
The type, or a base type, of the custom attribute to search for.
Return Value
Type: array<System::Attribute>An Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist.
| Exception | Condition |
|---|---|
| ArgumentNullException | element or attributeType is nullptr. |
| ArgumentException | attributeType is not derived from Attribute. |
| TypeLoadException | A custom attribute type cannot be loaded. |
The following code example demonstrates the use of GetCustomAttributes, taking a ParameterInfo as a parameter.
using namespace System; using namespace System::Reflection; using namespace System::ComponentModel; namespace CustAttrs5CS { public ref class AClass { public: void ParamArrayAndDesc( // Add ParamArray and Description attributes. [Description("This argument is a ParamArray")] array<Int32>^args ) {} }; ref class DemoClass { public: static void Main() { // Get the Class type to access its metadata. Type^ clsType = AClass::typeid; // Get the type information for the method. MethodInfo^ mInfo = clsType->GetMethod( "ParamArrayAndDesc" ); if ( mInfo != nullptr ) { // Get the parameter information. array<ParameterInfo^>^pInfo = mInfo->GetParameters(); if ( pInfo != nullptr ) { // Iterate through all the attributes for the parameter. System::Collections::IEnumerator^ myEnum4 = Attribute::GetCustomAttributes( pInfo[ 0 ] )->GetEnumerator(); while ( myEnum4->MoveNext() ) { Attribute^ attr = safe_cast<Attribute^>(myEnum4->Current); // Check for the ParamArray attribute. if ( attr->GetType() == ParamArrayAttribute::typeid ) Console::WriteLine( "Parameter {0} for method {1} " "has the ParamArray attribute.", pInfo[ 0 ]->Name, mInfo->Name ); // Check for the Description attribute. else // Check for the Description attribute. if ( attr->GetType() == DescriptionAttribute::typeid ) { Console::WriteLine( "Parameter {0} for method {1} " "has a description attribute.", pInfo[ 0 ]->Name, mInfo->Name ); Console::WriteLine( "The description is: \"{0}\"", (dynamic_cast<DescriptionAttribute^>(attr))->Description ); } } } } } }; } /* * Output: * Parameter args for method ParamArrayAndDesc has a description attribute. * The description is: "This argument is a ParamArray" * Parameter args for method ParamArrayAndDesc has the ParamArray attribute. */
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: