Export (0) Print
Expand All

DateTimeFormatInfo.GetAbbreviatedEraName Method

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

[Visual Basic]
Public Function GetAbbreviatedEraName( _
   ByVal era As Integer _
) As String
[C#]
public string GetAbbreviatedEraName(
 int era
);
[C++]
public: String* GetAbbreviatedEraName(
 int era
);
[JScript]
public function GetAbbreviatedEraName(
   era : int
) : String;

Parameters

era
The integer representing the era.

Return Value

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 Type 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 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, the abbreviated era name is the first character of the full era name; that is, either the single-character case-insensitive Latin alphabet abbreviation or the single-character Kanji abbreviation.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

DateTimeFormatInfo Class | DateTimeFormatInfo Members | System.Globalization Namespace | JapaneseCalendar | TaiwanCalendar

Show:
© 2014 Microsoft