CustomAttributeExtensions.GetCustomAttribute 方法

參考

定義

命名空間:: System.Reflection

組件:: System.Reflection.Extensions.dll

組件:: System.Runtime.dll

組件:: mscorlib.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

擷取套用至指定之項目的自訂屬性。

多載

GetCustomAttribute(Assembly, Type)	擷取指定型別的自訂屬性，此屬性套用至指定組件。
GetCustomAttribute(MemberInfo, Type)	擷取指定型別的自訂屬性，此屬性套用至指定成員。
GetCustomAttribute(Module, Type)	擷取指定型別的自訂屬性，此屬性套用至指定模組。
GetCustomAttribute(ParameterInfo, Type)	擷取指定型別的自訂屬性，此屬性套用至指定參數。
GetCustomAttribute(MemberInfo, Type, Boolean)	擷取只訂型別的自訂屬性，此屬性套用至指定成員，並且可選擇性檢查該成員的祖系。
GetCustomAttribute(ParameterInfo, Type, Boolean)	擷取只訂型別的自訂屬性，此屬性套用至指定參數，並且可選擇性檢查該參數的祖系。
GetCustomAttribute<T>(ParameterInfo, Boolean)	擷取只訂型別的自訂屬性，此屬性套用至指定參數，並且可選擇性檢查該參數的祖系。
GetCustomAttribute<T>(MemberInfo, Boolean)	擷取只訂型別的自訂屬性，此屬性套用至指定成員，並且可選擇性檢查該成員的祖系。
GetCustomAttribute<T>(ParameterInfo)	擷取指定型別的自訂屬性，此屬性套用至指定參數。
GetCustomAttribute<T>(Module)	擷取指定型別的自訂屬性，此屬性套用至指定模組。
GetCustomAttribute<T>(MemberInfo)	擷取指定型別的自訂屬性，此屬性套用至指定成員。
GetCustomAttribute<T>(Assembly)	擷取指定型別的自訂屬性，此屬性套用至指定組件。

GetCustomAttribute(Assembly, Type)

擷取指定型別的自訂屬性，此屬性套用至指定組件。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::Assembly ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.Assembly element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.Assembly element, Type attributeType);

static member GetCustomAttribute : System.Reflection.Assembly * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As Assembly, attributeType As Type) As Attribute

參數

element: Assembly

要檢查的組件。

attributeType: Type

要搜尋的屬性類型。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

AmbiguousMatchException

找到一個以上要求的屬性。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute(MemberInfo, Type)

擷取指定型別的自訂屬性，此屬性套用至指定成員。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::MemberInfo ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType);

static member GetCustomAttribute : System.Reflection.MemberInfo * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As MemberInfo, attributeType As Type) As Attribute

參數

element: MemberInfo

要檢查的成員。

attributeType: Type

要搜尋的屬性類型。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute(Module, Type)

擷取指定型別的自訂屬性，此屬性套用至指定模組。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::Module ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.Module element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.Module element, Type attributeType);

static member GetCustomAttribute : System.Reflection.Module * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As Module, attributeType As Type) As Attribute

參數

element: Module

要檢查的模型。

attributeType: Type

要搜尋的屬性類型。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

AmbiguousMatchException

找到一個以上要求的屬性。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute(ParameterInfo, Type)

擷取指定型別的自訂屬性，此屬性套用至指定參數。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::ParameterInfo ^ element, Type ^ attributeType);

public static Attribute GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType);

public static Attribute? GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType);

static member GetCustomAttribute : System.Reflection.ParameterInfo * Type -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As ParameterInfo, attributeType As Type) As Attribute

參數

element: ParameterInfo

要檢查的參數。

attributeType: Type

要搜尋的屬性類型。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute(MemberInfo, Type, Boolean)

擷取只訂型別的自訂屬性，此屬性套用至指定成員，並且可選擇性檢查該成員的祖系。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::MemberInfo ^ element, Type ^ attributeType, bool inherit);

public static Attribute GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType, bool inherit);

public static Attribute? GetCustomAttribute (this System.Reflection.MemberInfo element, Type attributeType, bool inherit);

static member GetCustomAttribute : System.Reflection.MemberInfo * Type * bool -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As MemberInfo, attributeType As Type, inherit As Boolean) As Attribute

參數

element: MemberInfo

要檢查的成員。

attributeType: Type

要搜尋的屬性類型。

inherit: Boolean

true 表示檢查element的祖系，否則為false。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute(ParameterInfo, Type, Boolean)

擷取只訂型別的自訂屬性，此屬性套用至指定參數，並且可選擇性檢查該參數的祖系。

public:
[System::Runtime::CompilerServices::Extension]
 static Attribute ^ GetCustomAttribute(System::Reflection::ParameterInfo ^ element, Type ^ attributeType, bool inherit);

public static Attribute GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType, bool inherit);

public static Attribute? GetCustomAttribute (this System.Reflection.ParameterInfo element, Type attributeType, bool inherit);

static member GetCustomAttribute : System.Reflection.ParameterInfo * Type * bool -> Attribute

<Extension()>
Public Function GetCustomAttribute (element As ParameterInfo, attributeType As Type, inherit As Boolean) As Attribute

參數

element: ParameterInfo

要檢查的參數。

attributeType: Type

要搜尋的屬性類型。

inherit: Boolean

true 表示檢查element的祖系，否則為false。

傳回

Attribute

符合 attributeType 的自訂屬性，如果找不到這樣的屬性則為 null。

例外狀況

ArgumentNullException

element 或 attributeType 為 null。

ArgumentException

attributeType 不是衍生自 Attribute。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(ParameterInfo, Boolean)

擷取只訂型別的自訂屬性，此屬性套用至指定參數，並且可選擇性檢查該參數的祖系。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::ParameterInfo ^ element, bool inherit);

public static T GetCustomAttribute<T> (this System.Reflection.ParameterInfo element, bool inherit) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.ParameterInfo element, bool inherit) where T : Attribute;

static member GetCustomAttribute : System.Reflection.ParameterInfo * bool -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As ParameterInfo, inherit As Boolean) As T

類型參數

T

要搜尋的屬性類型。

參數

element: ParameterInfo

要檢查的參數。

inherit: Boolean

true 表示檢查element的祖系，否則為false。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(MemberInfo, Boolean)

擷取只訂型別的自訂屬性，此屬性套用至指定成員，並且可選擇性檢查該成員的祖系。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::MemberInfo ^ element, bool inherit);

public static T GetCustomAttribute<T> (this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.MemberInfo element, bool inherit) where T : Attribute;

static member GetCustomAttribute : System.Reflection.MemberInfo * bool -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As MemberInfo, inherit As Boolean) As T

類型參數

T

要搜尋的屬性類型。

參數

element: MemberInfo

要檢查的成員。

inherit: Boolean

true 表示檢查element的祖系，否則為false。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(ParameterInfo)

擷取指定型別的自訂屬性，此屬性套用至指定參數。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::ParameterInfo ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.ParameterInfo element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.ParameterInfo element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.ParameterInfo -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As ParameterInfo) As T

類型參數

T

要搜尋的屬性類型。

參數

element: ParameterInfo

要檢查的參數。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(Module)

擷取指定型別的自訂屬性，此屬性套用至指定模組。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::Module ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.Module element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.Module element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.Module -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As Module) As T

類型參數

T

要搜尋的屬性類型。

參數

element: Module

要檢查的模型。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

AmbiguousMatchException

找到一個以上要求的屬性。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(MemberInfo)

擷取指定型別的自訂屬性，此屬性套用至指定成員。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::MemberInfo ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.MemberInfo element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.MemberInfo element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.MemberInfo -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As MemberInfo) As T

類型參數

T

要搜尋的屬性類型。

參數

element: MemberInfo

要檢查的成員。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

NotSupportedException

element 不是建構函式、方法、屬性、事件、型別或欄位。

AmbiguousMatchException

找到一個以上要求的屬性。

TypeLoadException

無法載入自訂屬性型別。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於

GetCustomAttribute<T>(Assembly)

擷取指定型別的自訂屬性，此屬性套用至指定組件。

public:
generic <typename T>
 where T : Attribute[System::Runtime::CompilerServices::Extension]
 static T GetCustomAttribute(System::Reflection::Assembly ^ element);

public static T GetCustomAttribute<T> (this System.Reflection.Assembly element) where T : Attribute;

public static T? GetCustomAttribute<T> (this System.Reflection.Assembly element) where T : Attribute;

static member GetCustomAttribute : System.Reflection.Assembly -> 'T (requires 'T :> Attribute)

<Extension()>
Public Function GetCustomAttribute(Of T As Attribute) (element As Assembly) As T

類型參數

T

要搜尋的屬性類型。

參數

element: Assembly

要檢查的組件。

傳回

T

符合 T 的自訂屬性，如果找不到這類屬性，則為 null。

例外狀況

ArgumentNullException

element 為 null。

AmbiguousMatchException

找到一個以上要求的屬性。

備註

如果您預期會傳回一個以上的值，請使用 GetCustomAttributes 擴充方法，否則將擲回 AmbiguousMatchException。

適用於