Enum.GetName Метод

Определение

Перегрузки

GetName(Type, Object)

Возвращает имя константы с заданным значением из указанного перечисления.Retrieves the name of the constant in the specified enumeration that has the specified value.

GetName<TEnum>(TEnum)

Возвращает имя константы с заданным значением из указанного типа перечисления.Retrieves the name of the constant in the specified enumeration type that has the specified value.

GetName(Type, Object)

Возвращает имя константы с заданным значением из указанного перечисления.Retrieves the name of the constant in the specified enumeration that has the specified value.

public:
 static System::String ^ GetName(Type ^ enumType, System::Object ^ value);
public static string GetName (Type enumType, object value);
public static string? GetName (Type enumType, object value);
[System.Runtime.InteropServices.ComVisible(true)]
public static string GetName (Type enumType, object value);
static member GetName : Type * obj -> string
[<System.Runtime.InteropServices.ComVisible(true)>]
static member GetName : Type * obj -> string
Public Shared Function GetName (enumType As Type, value As Object) As String

Параметры

enumType
Type

Тип перечисления.An enumeration type.

value
Object

Значение данной перечислимой константы в терминах ее базового типа.The value of a particular enumerated constant in terms of its underlying type.

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

String

Строка, содержащая имя константы перечислимого типа в enumType, значение которой равно value, или значение null, если такая константа не найдена.A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found.

Атрибуты

Исключения

Параметр enumType или value имеет значение null.enumType or value is null.

Параметр enumType не является классом Enum.enumType is not an Enum.

-или--or- value не является типом enumType и не имеет базового типа, совпадающего с типом enumType.value is neither of type enumType nor does it have the same underlying type as enumType.

Примеры

В следующем примере демонстрируется применение GetName.The following example illustrates the use of 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
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 метод гарантирует, что он возвратит имя одного из этих членов перечисления.If multiple enumeration members have the same underlying value, the GetName method guarantees that it will return the name of one of those enumeration members. Однако он не гарантирует, что он всегда будет возвращать имя того же члена перечисления.However, it does not guarantee that it will always return the name of the same enumeration member. В результате, если несколько членов перечисления имеют одинаковое значение, код приложения никогда не должен зависеть от метода, возвращающего имя определенного члена.As a result, when multiple enumeration members have the same value, your application code should never depend on the method returning a particular member's name.

GetName<TEnum>(TEnum)

Возвращает имя константы с заданным значением из указанного типа перечисления.Retrieves the name of the constant in the specified enumeration type that has the specified value.

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

Тип перечисления.The type of the enumeration.

Параметры

value
TEnum

Значение определенной перечислимой константы с учетом ее базового типа.The value of a particular enumerated constant in terms of its underlying type.

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

String

Строка, содержащая имя константы перечислимого типа в enumType, значение которой равно value, или значение null, если такая константа не найдена.A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found.

Применяется к