AddMonths Method

HijriCalendar.AddMonths Method

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

[Visual Basic]
Overrides Public Function AddMonths( _
   ByVal time As DateTime, _
   ByVal months As Integer _
) As DateTime
[C#]
public override DateTime AddMonths(
 DateTime time,
 int months
);
[C++]
public: DateTime AddMonths(
 DateTime time,
 int months
);
[JScript]
public override function AddMonths(
   time : DateTime,
 months : int
) : DateTime;

Parameters

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

Return Value

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

Exceptions

Exception Type Condition
ArgumentException The resulting DateTime is outside the supported range.
ArgumentOutOfRangeException months is less than -120000.

-or-

months is greater than 120000.

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 year part of the resulting DateTime is affected if the resulting month is outside the year of the specified DateTime. This implementation only supports 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 Zulkadah, which has 30 days, the specified day is the 30th day of that month, and the value of the months parameter is 3, the resulting year is one more than the specified year, the resulting month is Safar, and the resulting day is the 29th day, which is the last day in Safar.

If the value of the months parameter is negative, the resulting DateTime is earlier than the specified DateTime.

Example

[Visual Basic, C#, C++] The following code example displays the values of several components of a DateTime in terms of the Hijri calendar.

[Visual Basic] 
Imports System
Imports System.Globalization


Public Class SamplesHijriCalendar   

   Public Shared Sub Main()

      ' Sets a DateTime to April 3, 2002 of the Gregorian calendar.
      Dim myDT As New DateTime(2002, 4, 3, New GregorianCalendar())

      ' Creates an instance of the HijriCalendar.
      Dim myCal As 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)

   End Sub 'Main

   Public Shared Sub DisplayValues(myCal As Calendar, myDT As DateTime)
      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()
   End Sub 'DisplayValues

End Class '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



[C#] 
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

*/

[C++] 
#using <mscorlib.dll>
using namespace System;
using namespace System::Globalization;

void DisplayValues( Calendar* myCal, DateTime myDT )  {
   Console::WriteLine( S"   Era:        {0}", __box(myCal->GetEra( myDT )));
   Console::WriteLine( S"   Year:       {0}", __box(myCal->GetYear( myDT )));
   Console::WriteLine( S"   Month:      {0}", __box(myCal->GetMonth( myDT )));
   Console::WriteLine( S"   DayOfYear:  {0}", __box(myCal->GetDayOfYear( myDT )));
   Console::WriteLine( S"   DayOfMonth: {0}", __box(myCal->GetDayOfMonth( myDT )));
   Console::WriteLine( S"   DayOfWeek:  {0}", __box(myCal->GetDayOfWeek( myDT )));
   Console::WriteLine();
}

int main()  {

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

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

   // Displays the values of the DateTime.
   Console::WriteLine( S"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( S"After adding two years and ten months:" );
   DisplayValues( myCal, myDT );

}

/*
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

*/

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

HijriCalendar Class | HijriCalendar Members | System.Globalization Namespace | System.DateTime | AddYears | Calendar.AddWeeks | Calendar.AddDays | Calendar.AddHours | Calendar.AddMinutes | Calendar.AddSeconds | Calendar.AddMilliseconds

Show:
© 2016 Microsoft