System.Enum.GetName 方法

方法描述

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

语法定义(C# System.Enum.GetName 方法 的用法)

[ComVisibleAttribute(true)]
public static string GetName(
	Type enumType,
	Object value
)

参数/返回值

参数值/返回值 参数类型/返回类型 参数描述/返回描述
enumType System-Type 枚举类型。
value System-Object 特定枚举常数的值(根据其基础类型)。
返回值 System.String 一个字符串,其中包含 enumType 中值为 value 的枚举常数的名称;如果没有找到这样的常数,则为 null。

提示和注释

如果多个枚举成员具有相同的基础值,则 GetName 方法可保证它将返回其中一个枚举成员的名称。 但是,它并不保证它将始终返回相同枚举成员的名称。 因此,如果多个枚举成员具有相同的值,应用程序代码决不应依赖于返回特定成员名称的方法。

System.Enum.GetName 方法例子

下面的示例演示 GetName 的用法。

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

异常

异常 异常描述
ArgumentNullException enumType 或 value 为 null。
ArgumentException
  • enumType 不是 Enum。
  • value 既不是 enumType 类型,也没有与 enumType 相同的基础类型。

命名空间

namespace: System

程序集: mscorlib(在 mscorlib.dll 中)

版本信息

.NET Framework 受以下版本支持:4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持:4、3.5 SP1 受以下版本支持:

适用平台

Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008(不支持服务器核心), Windows Server 2008 R2(支持 SP1 或更高版本的服务器核心), Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表,请参见.NET Framework 系统要求。