GetAbsoluteYear Method (yearOfEra, era)

[This is preliminary documentation and is subject to change.]

Returns the "absolute year" (the one used throughout most of the API, without respect to eras) from a year-of-era and an era.

Declaration Syntax

Visual Basic

Visual C++

public int GetAbsoluteYear(
	int yearOfEra,
	Era era
)

Public Function GetAbsoluteYear ( _
	yearOfEra As Integer, _
	era As Era _
) As Integer

public:
int GetAbsoluteYear(
	int yearOfEra, 
	Era^ era
)

Parameters

yearOfEra (Int32): The year within the era.

era (Era): The era in which to consider the year

Return Value

The absolute year represented by the specified year of era.

Remarks

For example, in the Gregorian and Julian calendar systems, the BCE era starts at year 1, which is equivalent to an "absolute year" of 0 (then BCE year 2 has an absolute year of -1, and so on). The absolute year is the year that is used throughout the API; year-of-era is typically used primarily when formatting and parsing date values to and from text.

Exceptions

Exception	Condition
ArgumentNullException	era is null.
ArgumentOutOfRangeException	yearOfEra is out of the range of years for the given era.
ArgumentException	era is not an era used in this calendar.

Assembly: NodaTime (Module: NodaTime.dll) Version: 1.2.0.0 (1.2.0)