Enum.GetName Метод

Определение

Пространство имен:

System

Сборки:

netstandard.dll, System.Runtime.dll

Перегрузки

Имя	Описание
GetName(Type, Object)	Извлекает имя константы в указанном перечислении с указанным значением.
GetName<TEnum>(TEnum)	Извлекает имя константы в указанном типе перечисления с указанным значением.

GetName(Type, Object)

Исходный код:

Enum.cs

Извлекает имя константы в указанном перечислении с указанным значением.

public:
 static System::String ^ GetName(Type ^ enumType, System::Object ^ value);

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

static member GetName : Type * obj -> string

Public Shared Function GetName (enumType As Type, value As Object) As String

Параметры

enumType

Type

Тип перечисления.

value

Object

Значение определенной перечисленной константы с точки зрения его базового типа.

Возвращаемое значение

String

Строка, содержащая имя перечисленной константы в enumType значении value; или null если такая константа не найдена.

Исключения

ArgumentNullException

enumType или value есть null.

ArgumentException

enumType не Enumявляется .

–или–

value не имеет ни типа enumType , ни имеет тот же базовый тип, что enumTypeи .

InvalidOperationException

.NET 8 и более поздних версий: enumType является логическим типом перечисления.

Примеры

В следующем примере показано использование 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

open System

type Colors =
    | Red = 0
    | Green = 1
    | Blue = 2
    | Yellow = 3

type Styles =
    | Plaid = 0
    | Striped = 1
    | Tartan = 2
    | Corduroy = 3

printfn $"The 4th value of the Colors Enum is {Enum.GetName(typeof<Colors>, 3)}"
printfn $"The 4th value of the Styles Enum is {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

Public Class GetNameTest
    
    Enum Colors
        Red
        Green
        Blue
        Yellow
    End Enum 'Colors
    
    Enum Styles
        Plaid
        Striped
        Tartan
        Corduroy
    End Enum 'Styles
    
    Public Shared Sub Main() 
        Console.WriteLine("The 4th value of the Colors Enum is {0}", [Enum].GetName(GetType(Colors), 3))
        Console.WriteLine("The 4th value of the Styles Enum is {0}", [Enum].GetName(GetType(Styles), 3))
    End Sub
End Class
' 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

Извлекает имя константы в указанном типе перечисления с указанным значением.

public:
generic <typename TEnum>
 where TEnum : value class static System::String ^ GetName(TEnum value);

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

static member GetName : 'Enum -> string (requires 'Enum : struct)

Public Shared Function GetName(Of TEnum As Structure) (value As TEnum) As String

Параметры типа

TEnum

Тип перечисления.

Параметры

value

TEnum

Значение определенной перечисленной константы с точки зрения его базового типа.

Возвращаемое значение

String

Строка, содержащая имя перечисленной константы в TEnum значении value; или null если такая константа не найдена.

Исключения

InvalidOperationException

.NET 8 и более поздних версий: TEnum является логическим типом перечисления.