Instance Method インスタンスメソッド

components(_:from:to:options:)

Returns the difference between start and end dates given as date components. 日付構成要素として与えられた開始および終了日付の間の差を返します。

Declaration 宣言 

func components(_ unitFlags: NSCalendar.Unit, 
           from startingDateComp: DateComponents, 
             to resultDateComp: DateComponents, 
        options: NSCalendar.Options = []) -> DateComponents

Parameters パラメータ

unitFlags

Specifies the components for the returned NSDateComponents object. 返されるNSDateComponentsオブジェクトに対する構成要素を指定します。

startingDateComp

The start date for the calculation as an NSDateComponents object. 計算のための開始日付、NSDateComponentsオブジェクトとして。

resultDateComp

The end date for the calculation as an NSDateComponents object. 計算のための終了日付、NSDateComponentsオブジェクトとして。

options オプション

The options parameter is currently unused. optionsパラメータは現在は使われません。

Return Value 戻り値

An NSDateComponents object whose components are specified by unitFlags and calculated from the difference between the startingDateComp and resultDateComp using the options specified by options. Returns nil if either date falls outside the defined range of the receiver or if the computation cannot be performed. あるNSDateComponentsオブジェクト、それの構成要素はunitFlagsによって指定され、そしてstartingDateCompとresultDateCompの差からoptionsによって指定されるオプションを使って計算されます。nilを返します、もしどちらかの日付がレシーバの定義された範囲に収まらないならばまたは計算が実行できないならば。

Discussion 議論

If an NSDateComponents object does not specify a value for a calendar unit required to determine an absolute date, the base value of that unit is assumed. For example, given an NSDateComponents object with only a year and a month specified, the resulting NSDate object would be constructed using a day value of 1 and hour, minute, second and nanosecond values of 0. Passing an NSDateComponents argument with an unspecified era or year value is not advised. NSDateComponentsオブジェクトが絶対日付を決定するために要求されるカレンダー単位に対して値を指定しないならば、その単位の基準値が仮定されます。例えば、NSDateComponentsオブジェクトをyearとmonthだけ指定されて与えられるならば、結果のNSDateオブジェクトはday値の1とhour、minute、secondおよびnanosecond値の0を使って組み立てられるでしょう。NSDateComponents引数をeraまたはyear値を指定しないで渡すことは、勧められません。

If an NSDateComponents object's timeZone property is set, the time zone property value will be used in the calculation. If an NSDateComponents object's calendar property is set, the calendar property value will be used instead of the receiving calendar. If both an NSDateComponents object's timeZone and calendar properties are set, the time zone property value overrides the time zone of the calendar property value. NSDateComponentsオブジェクトのtimeZoneプロパティが設定されるならば、そのタイムゾーンプロパティ値は計算において使われます。NSDateComponentsオブジェクトのcalendarプロパティが設定されるならば、そのカレンダープロパティ値は受け取っているカレンダーの代わりに使われます。NSDateComponentsオブジェクトのtimeZoneおよびcalendarプロパティ値の両方が設定されるならば、タイムゾーンプロパティ値は、カレンダープロパティ値のタイムゾーンをオーバーライドします。

See Also 参照

Extracting Components 構成要素の抽出

func date(Date, matchesComponents: DateComponents) -> Bool
Returns whether a given date matches all of the given date components. 与えられた日付がその与えられた日付構成要素の全てと合致するかどうかを返します。
func component(NSCalendar.Unit, from: Date) -> Int
Returns the specified date component from a given date. 指定された日付構成要素をある与えられた日付から返します。
func components(NSCalendar.Unit, from: Date) -> DateComponents
Returns the date components representing a given date. 与えられた日付を表している日付構成要素を返します。
func components(NSCalendar.Unit, from: Date, to: Date, options: NSCalendar.Options) -> DateComponents
Returns the difference between two supplied dates as date components. ２つの提供された日付の間の差を日付構成要素として返します。
func components(in: TimeZone, from: Date) -> DateComponents
Returns all the date components of a date, as if in a given time zone (instead of the receiving calendar’s time zone). ある日付の日付構成要素すべてを返します、まるで与えられたタイムゾーンの中であるかのように（受け取っているカレンダーの持つタイムゾーンの代わりに）。
func getEra(UnsafeMutablePointer<Int>?, year: UnsafeMutablePointer<Int>?, month: UnsafeMutablePointer<Int>?, day: UnsafeMutablePointer<Int>?, from: Date)
Returns by reference the era, year, week of year, and weekday component values for a given date. 参照によって紀年、年、年内週番号、そして曜日構成要素をある与えられた日付に対して返します。
func getEra(UnsafeMutablePointer<Int>?, yearForWeekOfYear: UnsafeMutablePointer<Int>?, weekOfYear: UnsafeMutablePointer<Int>?, weekday: UnsafeMutablePointer<Int>?, from: Date)
Returns by reference the era, year, week of year, and weekday component values for a given date. 参照によって紀年、年、年内週番号、そして曜日構成要素をある与えられた日付に対して返します。
func getHour(UnsafeMutablePointer<Int>?, minute: UnsafeMutablePointer<Int>?, second: UnsafeMutablePointer<Int>?, nanosecond: UnsafeMutablePointer<Int>?, from: Date)
Returns by reference the hour, minute, second, and nanosecond component values for a given date. 参照によって時間、分、秒、そしてナノ秒構成要素をある与えられた日付に対して返します。