This documentation is archived and is not being maintained.

EastAsianLunisolarCalendar::AddYears Method

Calculates the date that is the specified number of years away from the specified date.

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

public:
virtual DateTime AddYears(
	DateTime time, 
	int years
) override

Parameters

time
Type: System::DateTime
The DateTime to which to add years.
years
Type: System::Int32
The number of years to add.

Return Value

Type: System::DateTime
A new DateTime that results from adding the specified number of years to the time parameter.

ExceptionCondition
ArgumentException

The result is outside the supported range of a DateTime.

ArgumentOutOfRangeException

time is less than MinSupportedDateTime or greater than MaxSupportedDateTime.

The day part of the resulting DateTime is affected if the resulting day is not a valid day in the resulting month of the resulting year. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The month part of the resulting DateTime remains the same as the specified DateTime. This implementation supports only the current era. Therefore, ArgumentException is thrown if the resulting year is outside the era of the specified DateTime. The time-of-day part of the resulting DateTime remains the same as the specified DateTime.

For example, February has 28 days, except during leap years when it has 29 days. If the specified date is the twenty-ninth day of February in a leap year and the value of the years parameter is 1, the resulting date will be the twenty-eighth day of February in the following year.

If years is negative, the resulting DateTime is earlier than the specified DateTime.

The Kind property of the returned DateTime value always equals DateTimeKind::Unspecified. You can preserve the Kind property of the time parameter by calling the DateTime::SpecifyKind method, as the following example shows.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: