HijriCalendar.GetLeapMonth(Int32, Int32) Method

Definition

Calculates the leap month for a specified year and era.

public:
 override int GetLeapMonth(int year, int era);
[System.Runtime.InteropServices.ComVisible(false)]
public override int GetLeapMonth (int year, int era);
override this.GetLeapMonth : int * int -> int
Public Overrides Function GetLeapMonth (year As Integer, era As Integer) As Integer

Parameters

year
Int32

A year.

era
Int32

An era. Specify CurrentEra or HijriEra.

Returns

Always 0 because the HijriCalendar type does not support the notion of a leap month.

Attributes

Exceptions

year is less than the Hijri calendar year 1 or greater than the year 9666.

-or-

era is not CurrentEra or HijriEra.

Remarks

In a calendar that supports the notion of a leap month, the leap month can occur either after a particular month or after any month in a year. For example, the GetMonth method returns a number between 1 and 13 that indicates the month associated with a specified date. If there is a leap month between the eighth and ninth months of the year, the GetMonth method returns 8 for the eighth month, 9 for the leap eighth month, and 10 for the ninth month.

Applies to