Enum.GetName Method
Retrieves the name of the constant in the specified enumeration that has the specified value.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
'Declaration <ComVisibleAttribute(True)> _ Public Shared Function GetName ( _ enumType As Type, _ value As Object _ ) As String
Parameters
- enumType
- Type: System.Type
An enumeration type.
- value
- Type: System.Object
The value of a particular enumerated constant in terms of its underlying type.
Return Value
Type: System.StringA string containing the name of the enumerated constant in enumType whose value is value; or Nothing if no such constant is found.
| Exception | Condition |
|---|---|
| ArgumentNullException | enumType or value is Nothing. |
| ArgumentException | enumType is not an Enum. -or- value is neither of type enumType nor does it have the same underlying type as enumType. |
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.
The following example illustrates the use of GetName.
Imports System 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 'Main End Class 'GetNameTest ' The example displays the following output: ' The 4th value of the Colors Enum is Yellow ' The 4th value of the Styles Enum is Corduroy
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
