• Article

DateTimeFormatInfo.GetAbbreviatedEraName Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns the string containing the abbreviated name of the specified era, if an abbreviation exists.

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

Syntax

'Declaration
Public Function GetAbbreviatedEraName ( _
    era As Integer _
) As String

public string GetAbbreviatedEraName(
    int era
)

Parameters

Return Value

Type: System.String
A string containing the abbreviated name of the specified era, if an abbreviation exists; or a string containing the full name of the era, if an abbreviation does not exist.

Exceptions

Exception Condition
ArgumentOutOfRangeException

era does not represent a valid era in the calendar specified in the Calendar property.

Remarks

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 valid values for era are returned by the Eras property of the appropriate class derived from Calendar. For example, the JapaneseCalendar.Eras property returns an array of integers that represent the eras that are supported by this implementation.

In the JapaneseCalendar, the abbreviated era name is the first character of the full era name. This character is either the single-character case-insensitive Latin alphabet abbreviation or the single-character Kanji abbreviation.

Notes to Callers

If DateTimeFormatInfo.Calendar is the TaiwanCalendar but the Thread.CurrentCulture is not "zh-TW", then GetEraName and GetAbbreviatedEraName return an empty string ("").

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.