EastAsianLunisolarCalendar.AddMonths(DateTime, Int32) Method

Definition

Namespace:

System.Globalization

Assembly:

System.Runtime.dll

Source:

EastAsianLunisolarCalendar.cs

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

public:
 override DateTime AddMonths(DateTime time, int months);

public override DateTime AddMonths (DateTime time, int months);

override this.AddMonths : DateTime * int -> DateTime

Public Overrides Function AddMonths (time As DateTime, months As Integer) As DateTime

Parameters

time

DateTime

The DateTime to which to add months.

months

Int32

The number of months to add.

Returns

DateTime

A new DateTime that results from adding the specified number of months to the time parameter.

Exceptions

ArgumentException

The result is outside the supported range of a DateTime.

ArgumentOutOfRangeException

months is less than -120000 or greater than 120000.

-or-

time is less than MinSupportedDateTime or greater than MaxSupportedDateTime.

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. In this case, the day part is changed to the last valid day in the resulting month of the resulting year. The year part of the resulting DateTime is affected if the resulting month is outside the year of 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, if the specified month is October, which has 31 days, the specified day is the thirty-first day of that month, and the value of the months parameter is 6, the resulting year is one more than the specified year, the resulting month is April, and the resulting day is the thirtieth day, which is the last day in April.

If the value of the months parameter 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.

returnTime = DateTime.SpecifyKind(cal.AddMonths(time, months), time.Kind);

returnTime = DateTime.SpecifyKind(cal.AddMonths(time, months), time.Kind)