Export (0) Print
Expand All

DateTimeFormatInfo.GetEra Method

Returns the integer representing the specified era.

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

'Declaration
Public Function GetEra ( _
	eraName As String _
) As Integer

Parameters

eraName
Type: System.String

The string containing the name of the era.

Return Value

Type: System.Int32
The integer representing the era, if eraName is valid; otherwise, -1.

ExceptionCondition
ArgumentNullException

eraName is Nothing.

The era name is the name a calendar uses to refer to a period of time reckoned from a fixed point or event. For example, "A.D." or "C.E." is the current era in the Gregorian calendar.

The comparison with eraName is case-insensitive, for example, "A.D." is equivalent to "a.d.".

GetEra ignores punctuation in abbreviated era names, only if the GregorianCalendar is selected in DateTimeFormatInfo.Calendar and the culture uses "A.D." as the era name, that is, "A.D." is equivalent to "AD".

GetEra compares eraName with the full era name returned by GetEraName and with the abbreviated era name returned by GetAbbreviatedEraName.

The following example shows that DateTimeFormatInfo ignores the punctuation in the era name, only if the calendar is Gregorian and the culture uses the era name "A.D.".

Imports System
Imports System.Globalization

Public Class SamplesGregorianCalendar

   Public Shared Sub Main()

      ' Creates strings with punctuation and without. 
      Dim strADPunc As [String] = "A.D." 
      Dim strADNoPunc As [String] = "AD" 
      Dim strCEPunc As [String] = "C.E." 
      Dim strCENoPunc As [String] = "CE" 

      ' Calls DTFI.GetEra for each culture that uses GregorianCalendar as the default calendar.
      Console.WriteLine("            ----- AD -----  ----- CE -----")
      Console.WriteLine("CULTURE     PUNC   NO PUNC  PUNC   NO PUNC  CALENDAR")
      Dim myCI As CultureInfo
      For Each myCI In  CultureInfo.GetCultures(CultureTypes.SpecificCultures)
         Console.Write("{0,-12}", myCI)
         Console.Write("{0,-7}{1,-9}", myCI.DateTimeFormat.GetEra(strADPunc), myCI.DateTimeFormat.GetEra(strADNoPunc))
         Console.Write("{0,-7}{1,-9}", myCI.DateTimeFormat.GetEra(strCEPunc), myCI.DateTimeFormat.GetEra(strCENoPunc))
         Console.Write("{0}", myCI.Calendar)
         Console.WriteLine()
      Next myCI

   End Sub 'Main 

End Class 'SamplesGregorianCalendar


'This code produces the following output.  This output has been cropped for brevity. 

'            ----- AD -----  ----- CE ----- 
'CULTURE     PUNC   NO PUNC  PUNC   NO PUNC  CALENDAR 
'ar-SA       -1     -1       -1     -1       System.Globalization.HijriCalendar 
'ar-IQ       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-EG       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-LY       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-DZ       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-MA       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-TN       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-OM       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-YE       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-SY       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-JO       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-LB       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-KW       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-AE       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-BH       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ar-QA       1      1        -1     -1       System.Globalization.GregorianCalendar 
'bg-BG       1      1        -1     -1       System.Globalization.GregorianCalendar 
'ca-ES       -1     -1       -1     -1       System.Globalization.GregorianCalendar 
'zh-TW       -1     -1       -1     -1       System.Globalization.GregorianCalendar 
'zh-CN       -1     -1       -1     -1       System.Globalization.GregorianCalendar 
'zh-HK       -1     -1       -1     -1       System.Globalization.GregorianCalendar 
'zh-SG       1      1        -1     -1       System.Globalization.GregorianCalendar 
'zh-MO       1      1        -1     -1       System.Globalization.GregorianCalendar 
'cs-CZ       -1     -1       -1     -1       System.Globalization.GregorianCalendar 
'da-DK       1      1        -1     -1       System.Globalization.GregorianCalendar

.NET Framework

Supported in: 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 Silverlight 8.1, Windows Phone Silverlight 8

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