Enum.GetName Metoda

Definicja

Przeciążenia

GetName(Type, Object)

Pobiera nazwę stałej w określonym wyliczeniu, która ma określoną wartość.Retrieves the name of the constant in the specified enumeration that has the specified value.

GetName<TEnum>(TEnum)

Pobiera nazwę stałej w określonym typie wyliczeniowym, który ma określoną wartość.Retrieves the name of the constant in the specified enumeration type that has the specified value.

GetName(Type, Object)

Pobiera nazwę stałej w określonym wyliczeniu, która ma określoną wartość.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

Parametry

enumType
Type

Typ wyliczenia.An enumeration type.

value
Object

Wartość konkretnej stałej wyliczenia w zakresie jej typu podstawowego.The value of a particular enumerated constant in terms of its underlying type.

Zwraca

String

Ciąg zawierający nazwę stałej wyliczenia w enumType której wartość to value lub null Jeśli nie można odnaleźć takiej stałej.A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found.

Atrybuty

Wyjątki

enumType lub value jest null .enumType or value is null.

enumType nie jest Enum .enumType is not an Enum.

-lub--or- value nie jest typem enumType ani nie ma tego samego typu podstawowego co enumType .value is neither of type enumType nor does it have the same underlying type as enumType.

Przykłady

Poniższy przykład ilustruje użycie 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

Uwagi

Jeśli wiele elementów członkowskich wyliczenia ma tę samą wartość bazową, GetName metoda gwarantuje, że zwróci nazwę jednego z tych elementów członkowskich wyliczenia.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. Jednak nie gwarantuje to, że zawsze zwróci nazwę tego samego elementu członkowskiego wyliczenia.However, it does not guarantee that it will always return the name of the same enumeration member. W związku z tym, gdy wiele elementów członkowskich wyliczenia ma taką samą wartość, kod aplikacji nigdy nie zależy od metody zwracającej nazwę określonego elementu członkowskiego.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.

Dotyczy

GetName<TEnum>(TEnum)

Pobiera nazwę stałej w określonym typie wyliczeniowym, który ma określoną wartość.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

Parametry typu

TEnum

Typ wyliczenia.The type of the enumeration.

Parametry

value
TEnum

Wartość konkretnej stałej wyliczenia w zakresie jej typu podstawowego.The value of a particular enumerated constant in terms of its underlying type.

Zwraca

String

Ciąg zawierający nazwę stałej wyliczenia w enumType której wartość to value lub null Jeśli nie można odnaleźć takiej stałej.A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found.

Dotyczy