Enum.GetName Método

Definição

Namespace:

System

Assembly:

System.Runtime.dll

Sobrecargas

GetName(Type, Object)	Recupera o nome da constante na enumeração especificada que tem o valor especificado.
GetName<TEnum>(TEnum)	Recupera o nome da constante no tipo de enumeração especificado que tem o valor especificado.

GetName(Type, Object)

Origem:

Enum.cs

Recupera o nome da constante na enumeração especificada que tem o valor especificado.

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

Parâmetros

enumType

Type

Um tipo de enumeração.

value

Object

O valor de uma constante enumerada específica em termos de seu tipo subjacente.

Retornos

String

Uma cadeia de caracteres que contém o nome da constante enumerada no enumType cujo valor é value, ou null, se tal constante não for encontrada.

Exceções

ArgumentNullException

enumType ou value é null.

ArgumentException

enumType não é um Enum.

- ou -

value não é do tipo enumType e não tem o mesmo tipo subjacente que enumType.

InvalidOperationException

.NET 8 e versões posteriores: enumType é um tipo de enumeração com suporte booliano.

Exemplos

O exemplo a seguir ilustra o uso de 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

Comentários

Se vários membros de enumeração tiverem o mesmo valor subjacente, o GetName método garantirá que ele retornará o nome de um desses membros de enumeração. No entanto, ele não garante que sempre retornará o nome do mesmo membro de enumeração. Como resultado, quando vários membros de enumeração têm o mesmo valor, o código do aplicativo nunca deve depender do método que retorna o nome de um membro específico.

GetName<TEnum>(TEnum)

Origem:

Enum.cs

Recupera o nome da constante no tipo de enumeração especificado que tem o valor especificado.

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

Parâmetros de tipo

TEnum

O tipo da enumeração.

Parâmetros

value

TEnum

O valor de uma constante enumerada específica em termos de seu tipo subjacente.

Retornos

String

Uma cadeia de caracteres que contém o nome da constante enumerada no TEnum cujo valor é value, ou null, se tal constante não for encontrada.

Exceções

InvalidOperationException

.NET 8 e versões posteriores: TEnum é um tipo de enumeração com suporte booliano.