This documentation is archived and is not being maintained.

Enum.GetNames Method

Retrieves an array of the names of the constants in a specified enumeration.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
<ComVisibleAttribute(True)> _
Public Shared Function GetNames ( _
	enumType As Type _
) As String()

Parameters

enumType
Type: System.Type
An enumeration type.

Return Value

Type: System.String()
A string array of the names of the constants in enumType.

ExceptionCondition
ArgumentNullException

enumType is Nothing.

ArgumentException

enumType parameter is not an Enum.

The elements of the return value array are sorted by the binary values of the enumerated constants (that is, by their unsigned magnitude). The following example displays information about the array returned by the GetNames method for an enumeration that includes a negative, zero, and positive value.


Public Enum SignMagnitude As Integer
   Negative = -1 
   Zero = 0
   Positive = 1
End Enum

Module Example
   Public Sub Main()
      Dim names() As String = CType([Enum].GetNames(GetType(SignMagnitude)), String())
      For Each name In names
         Console.WriteLine("{0,3:D}     0x{0:X}     {1}", 
                           [Enum].Parse(GetType(SignMagnitude), name), 
                           name)
      Next
   End Sub
End Module
' The example displays the following output:
'      0     0x00000000     Zero
'      1     0x00000001     Positive
'     -1     0xFFFFFFFF     Negative


If there are enumerated constants with same value, the order of their corresponding names is unspecified.

The following example illustrates the use of GetNames.


Public Class GetNamesTest
    Enum Colors
        Red
        Green
        Blue
        Yellow
    End Enum 

    Enum Styles
        Plaid
        Striped
        Tartan
        Corduroy
    End Enum

    Public Shared Sub Main()

        Console.WriteLine("The members of the Colors enum are:")
        For Each s In [Enum].GetNames(GetType(Colors))
            Console.WriteLine(s)
        Next

        Console.WriteLine()

        Console.WriteLine("The members of the Styles enum are:")
        For Each s In [Enum].GetNames(GetType(Styles))
            Console.WriteLine(s)
        Next
    End Sub
End Class
' The example displays the following output:
'       The members of the Colors enum are:
'       Red
'       Green
'       Blue
'       Yellow
'       
'       The members of the Styles enum are:
'       Plaid
'       Striped
'       Tartan
'       Corduroy


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: