Enum.GetName 方法

定义

命名空间:

System

程序集:

netstandard.dll, System.Runtime.dll

重载

GetName(Type, Object)	在指定枚举中检索具有指定值的常数的名称。
GetName<TEnum>(TEnum)	在指定枚举类型中检索具有指定值的常数的名称。

GetName(Type, Object)

Source:

Enum.cs

在指定枚举中检索具有指定值的常数的名称。

C#

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

参数

enumType

Type

枚举类型。

value

Object

特定枚举常量的值（根据其基础类型）。

返回

String

一个字符串，其中包含 enumType 中值为 value 的枚举常量的名称；或者，如果没有找到这样的常量，则为 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)

Source:

Enum.cs

在指定枚举类型中检索具有指定值的常数的名称。

C#

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

类型参数

TEnum

枚举的类型。

参数

value

TEnum

特定枚举常量的值（根据其基础类型）。

返回

String

一个字符串，其中包含 TEnum 中值为 value 的枚举常量的名称；或者，如果没有找到这样的常量，则为 null。

例外

InvalidOperationException

.NET 8 及更高版本： TEnum 是一种布尔支持的枚举类型。