Returns by reference the starting date and time interval range of the next weekend period after a given date.
- iOS 8.0+
- macOS 10.9+
- Mac Catalyst 13.0+Beta
- tvOS 9.0+
- watchOS 2.0+
Upon return, contains the starting date of the next weekend period.
Upon return, contains the time interval of the next weekend period.
Options for the calculation. If you specify a backward search option (
search), the starting date and time interval range of the preceding weekend period will be returned by reference instead.
The date for which to perform the calculation.
false if the calendar and locale do not have the concept of a weekend, otherwise
Note that a particular calendar day may not necessarily fall entirely within a weekend period, as weekends can start in the middle of a day in some calendars and locales.