UmAlQuraCalendar::AddYears Method
Calculates a date that is a specified number of years away from a specified initial date.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- time
- Type: System::DateTime
The date to which to add years. The UmAlQuraCalendar class supports only dates from 04/30/1900 00.00.00 (Gregorian date) through 05/13/2029 23:59:59 (Gregorian date).
- years
- Type: System::Int32
The positive or negative number of years to add.
Return Value
Type: System::DateTimeThe date yielded by adding the number of years specified by the years parameter to the date specified by the time parameter.
| Exception | Condition |
|---|---|
| ArgumentException | The resulting date is outside the range supported by the UmAlQuraCalendar class. |
| ArgumentOutOfRangeException | years is less than -10,000 or greater than 10,000. -or- time is outside the range supported by this calendar. |
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, an exception 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, Zulhijjah has 29 days, except during leap years when it has 30 days. If the specified date is the 30th day of Zulhijjah in a leap year and the value of the years parameter is 1, the resulting date is the 29th day of Zulhijjah 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.
The following example instantiates a DateTime value and displays the values of several of its components in the Um AL Qura calendar. Next, it calls the AddYears and AddMonths methods to add 2 years and 10 months in the Um Al Qura calendar to the date value. Finally, it again displays the values of these date components in the Um Al Qura calendar.
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.