Instance Method

rangeOfUnit:inUnit:forDate:

Returns the range of absolute time values that a smaller calendar unit (such as a day) can take on in a larger calendar unit (such as a month) that includes a specified absolute time.

Declaration

- (NSRange)rangeOfUnit:(NSCalendarUnit)smaller inUnit:(NSCalendarUnit)larger forDate:(NSDate *)date;

Parameters

smaller

The smaller calendar unit.

larger

The larger calendar unit.

date

The absolute time for which the calculation is performed.

Return Value

The range of absolute time values smaller can take on in larger at the time specified by date. Returns {NSNotFound, NSNotFound} if larger is not logically bigger than smaller in the calendar, or the given combination of units does not make sense (or is a computation which is undefined).

Discussion

You can use this method to calculate, for example, the range the Day unit can take on in the Month in which date lies.

See Also

Getting Calendar Information

calendarIdentifier

An identifier for the calendar.

firstWeekday

The index of the first weekday of the receiver.

locale

The locale of the receiver.

timeZone

The time zone for the calendar.

- maximumRangeOfUnit:

Returns the maximum range limits of the values that a given unit can take on.

- minimumRangeOfUnit:

Returns the minimum range limits of the values that a given unit can take on.

minimumDaysInFirstWeek

The minimum number of days in the first week of the receiver.

- ordinalityOfUnit:inUnit:forDate:

Returns, for a given absolute time, the ordinal number of a smaller calendar unit (such as a day) within a specified larger calendar unit (such as a week).

- rangeOfUnit:startDate:interval:forDate:

Returns by reference the starting time and duration of a given calendar unit that contains a given date.

- rangeOfWeekendStartDate:interval:containingDate:

Returns whether a given date falls within a weekend period, and if so, returns by reference the start date and time interval of the weekend range.

NSCalendarUnit

Calendrical units such as year, month, day and hour.