Enum.GetName 方法

定義

命名空間:

System

組件:

netstandard.dll, System.Runtime.dll

多載

GetName(Type, Object)	擷取有指定數值之指定列舉的常數名稱。
GetName<TEnum>(TEnum)	在具有指定數值的指定列舉類型中擷取常數名稱。

GetName(Type, Object)

來源:

Enum.cs

擷取有指定數值之指定列舉的常數名稱。

C#

public static string? GetName(Type enumType, object value);

參數

enumType

Type

列舉類型。

value

Object

就其基礎類型而論的特定列舉常數值。

傳回

String

字串 (包含值為 value 之 enumType 中的列舉常數名稱)；如果找不到這類常數，則為 null。

例外狀況

ArgumentNullException

enumType 或 value 為 null。

ArgumentException

enumType 不是 Enum。

-或-

value 既不是類型 enumType，也沒有和 enumType 一樣的基礎類型。

InvalidOperationException

.NET 8 和更新版本： enumType 是布林值支援的列舉類型。

範例

下列範例示範如何使用 GetName。

C#

using System;

public class GetNameTest {
    enum Colors { Red, Green, Blue, Yellow };
    enum Styles { Plaid, Striped, Tartan, Corduroy };

    public static void Main() {

        Console.WriteLine("The 4th value of the Colors Enum is {0}", Enum.GetName(typeof(Colors), 3));
        Console.WriteLine("The 4th value of the Styles Enum is {0}", Enum.GetName(typeof(Styles), 3));
    }
}
// The example displays the following output:
//       The 4th value of the Colors Enum is Yellow
//       The 4th value of the Styles Enum is Corduroy

備註

如果多個列舉成員具有相同的基礎值， GetName 此方法會保證它會傳回其中一個列舉成員的名稱。 不過，它不保證一律會傳回相同列舉成員的名稱。 如此一來，當多個列舉成員具有相同的值時，您的應用程式程式碼應該永遠都取決於傳回特定成員名稱的方法。

GetName<TEnum>(TEnum)

來源:

Enum.cs

在具有指定數值的指定列舉類型中擷取常數名稱。

C#

public static string? GetName<TEnum>(TEnum value) where TEnum : struct;

類型參數

TEnum

列舉的型別。

參數

value

TEnum

就其基礎類型而論的特定列舉常數值。

傳回

String

字串 (包含值為 value 之 TEnum 中的列舉常數名稱)；如果找不到這類常數，則為 null。

例外狀況

InvalidOperationException

.NET 8 和更新版本： TEnum 是布林值支援的列舉類型。