Enum.GetName Método

Definición

Espacio de nombres:

System

Ensamblado:

System.Runtime.dll

Sobrecargas

GetName(Type, Object)	Recupera el nombre de la constante de la enumeración especificada que tiene el valor especificado.
GetName<TEnum>(TEnum)	Recupera el nombre de la constante del tipo de enumeración especificado que tiene el valor especificado.

GetName(Type, Object)

Source:

Enum.cs

Recupera el nombre de la constante de la enumeración especificada que tiene el 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

Tipo de enumeración.

value

Object

Valor de una constante enumerada concreta en términos de su tipo subyacente.

Devoluciones

String

Cadena que contiene el nombre de la constante enumerada en enumType cuyo valor es value; o bien, null si no se encuentra dicha constante.

Excepciones

ArgumentNullException

enumType o value es null.

ArgumentException

enumType no es un objeto Enum.

o bien

value no es ni del tipo enumType ni tiene el mismo tipo subyacente que enumType.

InvalidOperationException

.NET 8 y versiones posteriores: enumType es un tipo de enumeración con respaldo booleano.

Ejemplos

En el siguiente ejemplo se muestra el 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

Comentarios

Si varios miembros de enumeración tienen el mismo valor subyacente, el GetName método garantiza que devolverá el nombre de uno de esos miembros de enumeración. Sin embargo, no garantiza que siempre devolverá el nombre del mismo miembro de enumeración. Como resultado, cuando varios miembros de enumeración tienen el mismo valor, el código de la aplicación nunca debe depender del método que devuelve el nombre de un miembro determinado.

GetName<TEnum>(TEnum)

Source:

Enum.cs

Recupera el nombre de la constante del tipo de enumeración especificado que tiene el 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

Tipo de la enumeración.

Parámetros

value

TEnum

Valor de una constante enumerada concreta en términos de su tipo subyacente.

Devoluciones

String

Cadena que contiene el nombre de la constante enumerada en TEnum cuyo valor es value; o bien, null si no se encuentra dicha constante.

Excepciones

InvalidOperationException

.NET 8 y versiones posteriores: TEnum es un tipo de enumeración con respaldo booleano.