DateTimeFormatInfo.GetAbbreviatedEraName(Int32) Method

Definition

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

public:
 System::String ^ GetAbbreviatedEraName(int era);
public string GetAbbreviatedEraName (int era);
member this.GetAbbreviatedEraName : int -> string
Public Function GetAbbreviatedEraName (era As Integer) As String

Parameters

era
Int32

The integer representing the era.

Returns

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

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 listed in the Eras property of the appropriate class derived from Calendar. For example: JapaneseCalendar.Eras displays a list of eras that are supported by this implementation.

In the JapaneseCalendar class, 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 Calendar is the TaiwanCalendar but the CurrentCulture is not "zh-TW", then NativeCalendarName, GetEraName(Int32), and GetAbbreviatedEraName(Int32) return an empty string ("").

Applies to

See also