Export (0) Print
Expand All

Enum.GetUnderlyingType Method

Returns the underlying type of the specified enumeration.

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

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

Parameters

enumType
Type: System.Type

The enumeration whose underlying type will be retrieved.

Return Value

Type: System.Type
The underlying type of enumType.

ExceptionCondition
ArgumentNullException

enumType is Nothing.

ArgumentException

enumType is not an Enum.

The Enum structure enables values to be represented as named constants. The data type of the enumeration's values is known as its underlying type. For example, the underlying type of the DayOfWeek enumeration, which consists of constants that represent each day of the week (DayOfWeek.Monday, DayOfWeek.Tuesday, and so on), is Int32.

The following example calls the GetUnderlyingType method to display the underlying type of some enumeration members.

Module Example
   Public Sub Main()
      Dim enumValues() As [Enum] = { ConsoleColor.Red, DayOfWeek.Monday, 
                                     MidpointRounding.ToEven, PlatformID.Win32NT, 
                                     DateTimeKind.Utc, StringComparison.Ordinal }
      Console.WriteLine("{0,-10} {1, 18}   {2,15}", 
                        "Member", "Enumeration", "Underlying Type")
      Console.WriteLine()
      For Each enumValue In enumValues
         DisplayEnumInfo(enumValue)
      Next 
   End Sub 

   Sub DisplayEnumInfo(enumValue As [Enum])
      Dim enumType As Type = enumValue.GetType()
      Dim underlyingType As Type = [Enum].GetUnderlyingType(enumType)
      Console.WriteLine("{0,-10} {1, 18}   {2,15}",
                        enumValue, enumType.Name, underlyingType.Name)   
   End Sub 
End Module 
' The example displays the following output: 
'       Member            Enumeration   Underlying Type 
'        
'       Red              ConsoleColor             Int32 
'       Monday              DayOfWeek             Int32 
'       ToEven       MidpointRounding             Int32 
'       Win32NT            PlatformID             Int32 
'       Utc              DateTimeKind             Int32 
'       Ordinal      StringComparison             Int32

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.

Show:
© 2014 Microsoft