Attribute.GetCustomAttribute Method (MemberInfo, Type, Boolean)
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Retrieves a custom attribute applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
Public Shared Function GetCustomAttribute ( _
element As MemberInfo, _
attributeType As Type, _
inherit As Boolean _
) As Attribute
public static Attribute GetCustomAttribute(
MemberInfo element,
Type attributeType,
bool inherit
)
Parameters
- element
Type: System.Reflection..::.MemberInfo
An object derived from the MemberInfo class that describes a constructor, event, field, method, or property member of a class.
- attributeType
Type: System..::.Type
The type, or a base type, of the custom attribute to search for.
- inherit
Type: System..::.Boolean
If true, specifies to also search the ancestors of element for custom attributes.
Return Value
Type: System..::.Attribute
A reference to the single custom attribute of type attributeType that is applied to element, or nullNothingnullptra null reference (Nothing in Visual Basic) if there is no such attribute.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | element or attributeType is nullNothingnullptra null reference (Nothing in Visual Basic). |
| ArgumentException | attributeType is not derived from Attribute. |
| NotSupportedException | element is not a constructor, method, property, event, type, or field. |
| AmbiguousMatchException | More than one of the requested attributes was found. |
| TypeLoadException | A custom attribute type cannot be loaded. |
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1, 7.0
Platforms
Windows Phone