dateDiffInYears( )

2つの日付の差を年単位で計算します。

dateDiffInYears( )ヘルパー・ファンクションは、パラメータとして渡された開始日と終了日を使用して起動されます。この関数は、2つの日付の差を示す負または正の数値を返します。

ノート:

日付ヘルパー関数にパラメータを指定する順序は重要です。結果の戻り値は、最初のパラメータまたは2番目のパラメータとして渡す日付によって異なります。

この関数は、時間要素を含まず、日付の一部を含まない日付型の変数を比較するためにのみ使用されます。日時タイプ・パラメータを使用する場合、関数は日付部分のみを考慮し、時間要素は無視されます。

ヒント:

• timeDiffInMinutes( )ヘルパー関数を使用すると、2つの日時アイテムを比較できます。
• 日付の質問に日付要素の一部が含まれている場合は、getDatesCompareResult( )ヘルパー関数を使用します。

構文

dateDiffInYears(toDate, fromDate)

パラメータ

ノート:

同じ書式の日付を比較する必要があります。

パラメータ	必須/オプション	説明
toDate	必須	終了日の値。
fromDate	必須	開始日の値。

戻り値です。

渡された日付(年)の差異を表す数値。この数値は正または負のいずれかです。

• 返される数値の値が負の値またはゼロの値の場合、toDateはfromDateの前または同じであることを意味します。
• ファンクションが正の値を返す場合、toDateはfromDateの後になります。

例

例3-5 2つの日付項目の差異

// Given 2 form questions of type Date (with no time elements) are defined in the rule as variables:
return dateDiffInYears(dateItem1, dateItem2);

例3-6ハードコードされた2つの日付の差異

var toDate = new Date("March 1, 2020");
var fromDate = new Date("March 1, 2000");
return dateDiffInYears(toDate, fromDate);
 
// Returns value: 20