This documentation is archived and is not being maintained.

HijriCalendar.AddYears Method

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

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

public override DateTime AddYears (
	DateTime time,
	int years
)
public DateTime AddYears (
	DateTime time, 
	int years
)
public override function AddYears (
	time : DateTime, 
	years : int
) : DateTime

Parameters

time

The DateTime object to add years to.

years

The number of years to add.

Return Value

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

Exception typeCondition

ArgumentException

The resulting DateTime object is outside the supported range.

The day part of the resulting DateTime object 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 object remains the same as the specified DateTime object. This implementation supports only the current era; therefore, ArgumentException is thrown if the resulting year is outside the era of the specified DateTime object. The time-of-day part of the resulting DateTime object remains the same as the specified DateTime object.

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 years is 1, the resulting date will be the 29th day of Zulhijjah in the following year.

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

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

using System;
using System.Globalization;


public class SamplesHijriCalendar  {

   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 HijriCalendar.
      HijriCalendar myCal = new HijriCalendar();

      // Displays the values of the DateTime.
      Console.WriteLine( "April 3, 2002 of the Gregorian calendar equals the following in the Hijri 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 Hijri calendar:
   Era:        1
   Year:       1423
   Month:      1
   DayOfYear:  21
   DayOfMonth: 21
   DayOfWeek:  Wednesday

After adding two years and ten months:
   Era:        1
   Year:       1425
   Month:      11
   DayOfYear:  316
   DayOfMonth: 21
   DayOfWeek:  Saturday

*/

import System.*;
import System.Globalization.*;

public class SamplesHijriCalendar
{  
    public static void main(String[] args)
    {
        // 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 HijriCalendar.
        HijriCalendar myCal =  new HijriCalendar();

        // Displays the values of the DateTime.
        Console.WriteLine("April 3,2002 of the Gregorian calendar equals the"
            + " following in the Hijri 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);
    } //main    
   
    public static void DisplayValues(Calendar myCal, DateTime myDT)
    {
        Console.WriteLine("   Era:        {0}",
            System.Convert.ToString(myCal.GetEra(myDT)));
        Console.WriteLine("   Year:       {0}",
            System.Convert.ToString(myCal.GetYear(myDT)));
        Console.WriteLine("   Month:      {0}",
            System.Convert.ToString(myCal.GetMonth(myDT)));
        Console.WriteLine("   DayOfYear:  {0}",
            System.Convert.ToString(myCal.GetDayOfYear(myDT)));
        Console.WriteLine("   DayOfMonth: {0}",
            System.Convert.ToString(myCal.GetDayOfMonth(myDT)));
        Console.WriteLine("   DayOfWeek:  {0}",
            System.Convert.ToString(myCal.GetDayOfWeek(myDT)));
        Console.WriteLine();
    } //DisplayValues
} //SamplesHijriCalendar 

/*
This code produces the following output.

April 3, 2002 of the Gregorian calendar equals the following in the 
Hijri calendar:
   Era:        1
   Year:       1423
   Month:      1
   DayOfYear:  21
   DayOfMonth: 21
   DayOfWeek:  Wednesday

After adding two years and ten months:
   Era:        1
   Year:       1425
   Month:      11
   DayOfYear:  316
   DayOfMonth: 21
   DayOfWeek:  Saturday

*/

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: