DateTimeFormatInfo.GetAbbreviatedEraName Method
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Returns the string containing the abbreviated name of the specified era, if an abbreviation exists.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- era
- Type: System.Int32
The integer representing the era.
Return Value
Type: System.StringA 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.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | era does not represent a valid era in the calendar specified in the Calendar property. |
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 CallersIf DateTimeFormatInfo.Calendar is the TaiwanCalendar but the Thread.CurrentCulture is not "zh-TW", then GetEraName and GetAbbreviatedEraName return an empty string ("").