EastAsianLunisolarCalendar.AddYears Method (DateTime, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public override DateTime AddYears(
	DateTime time,
	int years
)

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.

Exception Condition
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.

TheKind 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.

returnTime = DateTime.SpecifyKind(cal.AddYears(time, years), time.Kind);

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show: