fn:months-from-duration 関数

fn:months-from-duration 関数は、 期間値の月コンポーネントを戻します。

構文

構文図を読む
>>-fn:months-from-duration(duration-value)---------------------><

duration-value
月コンポーネントの抽出元の期間値。

duration-value は、空のシーケンスか、または xs:dayTimeDuration、 xs:duration、xs:yearMonthDuration のいずれかのタイプの値です。

戻り値

戻り値は、 以下のように、duration-value のタイプによって決まります。

  • duration-value が xs:duration タイプまたは xs:yearMonthDuration タイプの場合、戻り値は xs:integer タイプであり、 -11 から 11 (両端を含む) の範囲内の値です。値は、xs:yearMonthDuration としてキャストされた duration-value の月コンポーネントです。 duration-value が負の場合、値は負になります。
  • duration-value が xs:dayTimeDuration タイプの場合、 戻り値は 0 です。
  • duration-value が空シーケンスである場合、戻り値は空シーケンスです。

xs:yearMonthDuration として キャストされた duration-value の月コンポーネントは、 duration-value の月の総数を 12 で除算して 余った月数 (整数) です。

例

次の関数は、 20 年と 5 カ月の期間の月コンポーネントを 戻します。

fn:months-from-duration(xs:duration("P20Y5M"))

戻り値は 5 です。

次の関数は、-9 年と -13 カ月の yearMonthDuration の月コンポーネントを戻します。

fn:months-from-duration(xs:yearMonthDuration("-P9Y13M"))

戻り値は -1 です。期間内の総月数を計算する場合、 -13 カ月は -1 年と -1 カ月に変換します。 期間は -P10Y1M に等しく、-P10Y1M の月コンポーネントは -1 カ月です。

次の関数は、 14 年 11 カ月 40 日 13 時間の期間の月コンポーネントを戻します。

xquery fn:months-from-duration(xs:duration("P14Y11M40DT13H"))

戻り値は 11 です。