KoreanCalendar.AddYears(DateTime, Int32) Method

Definition

Namespace:

System.Globalization

Assemblies:

netstandard.dll, System.Runtime.dll

Source:

KoreanCalendar.cs

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

C#

public override DateTime AddYears(DateTime time, int years);

Parameters

time

DateTime

The DateTime to which to add years.

years

Int32

The number of years to add.

Returns

DateTime

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

Exceptions

ArgumentOutOfRangeException

years or time is out of range.

Examples

The following code example displays the values of several components of a DateTime in terms of the Korean calendar.

C#

using System;
using System.Globalization;

public class SamplesKoreanCalendar  {

   public static void Main()  {

      // Sets a DateTime to April 3, 2002 of the Gregorian calendar.
      DateTime myDT = new DateTime( 2002, 4, 3, new GregorianCalendar() );

      // Creates an instance of the KoreanCalendar.
      KoreanCalendar myCal = new KoreanCalendar();

      // Displays the values of the DateTime.
      Console.WriteLine( "April 3, 2002 of the Gregorian calendar equals the following in the Korean calendar:" );
      DisplayValues( myCal, myDT );

      // Adds two years and ten months.
      myDT = myCal.AddYears( myDT, 2 );
      myDT = myCal.AddMonths( myDT, 10 );

      // Displays the values of the DateTime.
      Console.WriteLine( "After adding two years and ten months:" );
      DisplayValues( myCal, myDT );
   }

   public static void DisplayValues( Calendar myCal, DateTime myDT )  {
      Console.WriteLine( "   Era:        {0}", myCal.GetEra( myDT ) );
      Console.WriteLine( "   Year:       {0}", myCal.GetYear( myDT ) );
      Console.WriteLine( "   Month:      {0}", myCal.GetMonth( myDT ) );
      Console.WriteLine( "   DayOfYear:  {0}", myCal.GetDayOfYear( myDT ) );
      Console.WriteLine( "   DayOfMonth: {0}", myCal.GetDayOfMonth( myDT ) );
      Console.WriteLine( "   DayOfWeek:  {0}", myCal.GetDayOfWeek( myDT ) );
      Console.WriteLine();
   }
}

/*
This code produces the following output.

April 3, 2002 of the Gregorian calendar equals the following in the Korean calendar:
   Era:        1
   Year:       4335
   Month:      4
   DayOfYear:  93
   DayOfMonth: 3
   DayOfWeek:  Wednesday

After adding two years and ten months:
   Era:        1
   Year:       4338
   Month:      2
   DayOfYear:  34
   DayOfMonth: 3
   DayOfWeek:  Thursday

*/

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

C#

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

Applies to

See also

• DateTime
• AddMonths(DateTime, Int32)
• AddWeeks(DateTime, Int32)
• AddDays(DateTime, Int32)
• AddHours(DateTime, Int32)
• AddMinutes(DateTime, Int32)
• AddSeconds(DateTime, Int32)
• AddMilliseconds(DateTime, Double)