Enum.GetName Метод

Определение

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

System

Сборка:

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 namespace System;

enum class Colors
{
   Red, Green, Blue, Yellow
};

enum class Styles
{
   Plaid, Striped, Tartan, Corduroy
};

int main()
{
   Console::WriteLine(  "The 4th value of the Colors Enum is {0}", Enum::GetName( Colors::typeid, 3 ) );
   Console::WriteLine(  "The 4th value of the Styles Enum is {0}", Enum::GetName( Styles::typeid, 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

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 является логическим типом перечисления.