System.Globalization.ThaiBuddhistCalendar.AddYears Method

Returns a DateTime that is the specified number of years away from the specified DateTime.

Syntax

public override DateTime AddYears (DateTime time, int years)

Parameters

time
The DateTime to which to add years.
years
The number of years to add.

Returns

The DateTime that results from adding the specified number of years to the specified DateTime.

Remarks

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. It 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 29th day of February in a leap year and the value of years is 1, the resulting date is the 28th day of February in the following year.

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

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

code reference: System.Globalization.Calendar.AddMethods#8

Requirements

Namespace: System.Globalization
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0