BirtDateTime クラスには、2 つの日付または時刻の間の時間量の判別、時間幅の加算または減算、および日付の一部を取得するための関数があります。日付の幅は数値のみなので、アプリケーションでは乗算、除算、加算、減算などの通常の演算を使用できます。このクラスは静的です。アプリケーションでは、このクラスのインスタンスは作成できません。
この関数は、指定した日数を日付に加算した結果得られる新しい日付を戻します。加算する日数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
Date オブジェクト。開始日を表す日付オブジェクト。
n
Number オブジェクト。日付に加算する日数。小数部は切り捨てられて直近の整数になり、整数として扱われます。
戻り値
Date オブジェクト。指定した日数を開始日に加算した結果の日付。
例
以下の例は、特定の日付に日数を加算します。
以下の例は、InvoiceDate フィールドの各日付の値に 15 日を加算します。
この関数は、指定した時間数を日付に加算した結果得られる新しい日付を戻します。加算する時間数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。開始日に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
n
Number オブジェクト。日付に加算する時間数。
戻り値
Date オブジェクト。指定した時間数を開始日に加算した結果の日付。
例
以下の例は、特定の日付と時刻に時間を加算します。
以下の例は、StartTime フィールドの各日付の値に 36 時間を加算します。
この関数は、指定した分数を日付に加算した結果得られる新しい日付を戻します。加算する分数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。開始日に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
n
Number オブジェクト。日付に加算する分数。
戻り値
Date オブジェクト。指定した分数を開始日に加算した結果の日付。
例
以下の例は、特定の日付と時刻に分数を加算します。
以下の例は、StartTime フィールドの各日付の値に 15 分を加算します。
この関数は、指定した月数を日付に加算した結果得られる新しい日付を戻します。加算する月数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
この関数は、常に有効な日付を戻します。必要な場合、結果の日付の日部分は、結果の年における結果の月の最終日に合わせるために下方減算されます。例えば、2008 年 1 月 31 日に 1 カ月加算する場合、2008 年はうるう年のため、addMonth( ) は 2008 年 2 月 31 日ではなく、2008 年 2 月 29 日を戻します。
構文
パラメーター
日付
Date オブジェクト。開始日を表す日付オブジェクト。
n
Number オブジェクト。日付に加算する月数。小数部は切り捨てられて、整数として扱われます。
戻り値
Date オブジェクト。指定した月数を開始日に加算した結果の日付。
例
以下の例は、特定の日付に月数を加算します。
以下の例は、InvoiceDate フィールドの各日付の値に 10 カ月を加算します。
この関数は、指定した四半期数を日付に加算した結果得られる新しい日付を戻します。四半期は 3 カ月と同等です。例えば、2008 年 9 月 10 日に 2 四半期を加算する場合、関数は 2009 年 3 月 10 日を戻します。加算する四半期数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。
n
Number オブジェクト。日付に加算する四半期数。
戻り値
Date オブジェクト。指定した四半期数を開始日に加算した結果の日付。
例
以下の例は、特定の日付に四半期数を加算します。
以下の例は、ForecastClosing フィールドの各日付の値に 2 四半期を加算します。
この関数は、指定した秒数を日付に加算した結果得られる新しい日付を戻します。加算する秒数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。開始日に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
n
Number オブジェクト。日付に加算する秒数。
戻り値
Date オブジェクト。指定した秒数を開始日に加算した結果。
例
以下の例は、特定の日付と時刻に秒数を加算します。
以下の例は、StartTime フィールドの各日付の値に 6000 秒を加算します。
この関数は、指定した週数を日付に加算した結果得られる新しい日付を戻します。加算する週数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。
n
Number オブジェクト。日付に加算する週数。
戻り値
Date オブジェクト。指定した週数を開始日に加算した結果の日付。
例
以下の例は、特定の日付に週数を加算します。
以下の例は、InvoiceDate フィールドの各日付の値に 2 週を加算します。
この関数は、指定した年数を日付に加算した結果得られる新しい日付を戻します。加算する年数は負の値にもできます。この場合、結果は日付からその数が減算された場合と同様になります。
構文
パラメーター
日付
開始日を表す日付オブジェクト。
n
Number オブジェクト。日付に加算する年数。小数部は切り捨てられて、整数として扱われます。
戻り値
指定した年数を開始日に加算した結果の日付。
例
以下の例は、特定の日付に年数を加算します。
以下の例は、HireDate フィールドの各日付の値に 5 年を加算します。
この関数は、指定した日付の日を表す番号 (1 から 31) を戻します。例えば、日付が 2009-01-19 の場合、19 を戻します。
構文
パラメーター
日付
Date オブジェクト。日の取得元である日付オブジェクト。
戻り値
指定した日付の日を表す整数。
例
以下の例は、ShipDate フィールドの各値の日を戻します。
以下の例は、現在日付の日を戻します。
この関数は、2 つの日付の間の日数を戻します。日は、2 番目の日付の日の値から最初の日付の日の値を減算して計算されます。例えば、最初の日付が 2008-12-30 23:59:59 で、2 番目の日付が 2008-12-31 00:00:00 の場合、2 つの日付が 1 秒しか離れていないとしても 1 日を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の日数。
例
以下の例は、特定の日付の間の日数を戻します。
以下の例は、現在日付から 2009 年末までの日数を戻します。
以下の例は、InvoiceDate フィールドの値と PaymentDate フィールドの値の間の日数を戻します。
この関数は、2 つの日付の間の時間数を戻します。時間は、2 番目の日付の時刻の値から最初の日付の時刻の値を減算して計算されます。例えば、最初の日付が 2009-01-31 1:30:00 で、2 番目の日付が 2009-01-31 2:00:00 の場合、2 つの日付が 30 分しか離れていないとしても 1 時間を戻します。日付に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の時間数。
例
以下の例は、特定の日付の間の時間数を戻します。
以下の例は、現在日付と時刻から 2009 年末までの時間数を戻します。
以下の例は、StartTime フィールドの値と FinishTime フィールドの値の間の時間数を戻します。
この関数は、2 つの日付の間の分数を戻します。分は、2 番目の日付の分の値から最初の日付の分の値を減算して計算されます。例えば、最初の日付が 2009-01-31 1:30:59 で、2 番目の日付が 2009-01-31 1:31:00 の場合、2 つの日付が 1 秒しか離れていないとしても 1 分を戻します。日付に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の分数。
例
以下の例は、特定の日付の間の分数を戻します。
以下の例は、現在日付と時刻から 2010 年の初日までの分数を戻します。
以下の例は、StartTime フィールドの値と FinishTime フィールドの値の間の分数を戻します。
この関数は、2 つの日付の間の月数を戻します。月は、2 番目の日付の月の値から最初の日付の月の値を減算して計算されます。例えば、最初の日付が 2009-01-31 で、2 番目の日付が 2009-02-01 の場合、2 つの日付が 1 日しか離れていないとしても、1 カ月を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の月数。
例
以下の例は、特定の日付の間の月数を戻します。
以下の例は、現在日付から 2010 年の初日までの月数を戻します。
以下の例は、ProjectStart フィールドの値と ProjectComplete フィールドの値の間の月数を戻します。
この関数は、2 つの日付の間の四半期数を戻します。四半期は、2 番目の日付の月の値から最初の日付の月の値を減算して計算されます。3 カ月の差は 1 四半期と同等です。例えば、最初の日付が 2009-01-31 で 2 番目の日付が 2009-07-01 の場合は 2 を戻します。最初の日付が 2009-01-01 で 2 番目の日付が 2009-09-30 の場合も、2 を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の四半期数。
例
以下の例は、特定の日付の間の四半期数を戻します。
以下の例は、現在日付から 2010 年の初日までの四半期数を戻します。
以下の例は、ProjectStart フィールドの値と ProjectComplete フィールドの値の間の四半期数を戻します。
この関数は、2 つの日付の間の秒数を戻します。日付に時刻の値が含まれていない場合、時刻は午前 0 時 (00:00:00) であると見なされます。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の秒数。
例
以下の例は、特定の日付の間の秒数を戻します。
以下の例は、現在日付と時刻から 2010 年の初日までの秒数を戻します。
以下の例は、StartTime フィールドの値と FinishTime フィールドの値の間の秒数を戻します。
この関数は、2 つの日付の間の週数を戻します。週は、2 番目の日付の週数から最初の日付の週数を減算して計算されます。例えば、最初の日付が 2009-01-02 (年の第 1 週) で 2 番目の日付が 2009-01-05 (年の第 2 週) の場合、2 つの日付が 3 日しか離れていないとしても、1 週を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の週数。
例
以下の例は、特定の日付の間の週数を戻します。
以下の例は、現在日付から 2010 年の初日までの週数を戻します。
以下の例は、ProjectStart フィールドの値と ProjectComplete フィールドの値の間の週数を戻します。
この関数は、2 つの日付の間の年数を戻します。年は、2 番目の日付の年の値から最初の日付の年の値を減算して計算されます。例えば、最初の日付が 2009-01-01 で 2 番目の日付が 2009-12-31 の場合は 0 を戻します。最初の日付が 2008-11-15 で 2 番目の日付が 2009-01-15 の場合は 1 を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の年数。
例
以下の例は、特定の日付の間の年数を戻します。
以下の例は、HireDate フィールドの値と現在日付の間の年数を戻します。
この関数は、2 つの日付の間の年数を戻します。年は、2 番目の日付の年の値から最初の日付の年の値を減算して計算されます。例えば、最初の日付が 2009-01-01 で 2 番目の日付が 2009-12-31 の場合は 0 を戻します。最初の日付が 2008-11-15 で 2 番目の日付が 2009-01-15 の場合は 1 を戻します。
構文
パラメーター
日付 1
時間幅の開始を表す日付オブジェクト。
日付 2
時間幅の終了を表す日付オブジェクト。
戻り値
Integer 型。2 つの日付の間の年数。
例
以下の例は、特定の日付の間の年数を戻します。
以下の例は、HireDate フィールドの値と現在日付の間の年数を戻します。
この関数は、入力した日付の属する月の初日の日付を戻します。
構文
パラメーター
日付
月の取得元である日付オブジェクト。
戻り値
Date オブジェクト。指定した日付の属する月の初日。
例
以下の例は、特定の日付に戻された月の値を示しています。
この関数は、入力した日付の属する四半期の初日の日付を戻します。
構文
パラメーター
日付
四半期の取得元である日付オブジェクト。
戻り値
Date オブジェクト。指定した日付の属する四半期の初日。
例
以下の例は、特定の日付に戻された四半期の値を示しています。
この関数は、入力した日付の属する週の初日の日付を戻します。米国の場合、これは日曜日になります。
構文
パラメーター
日付
週の取得元である日付オブジェクト。
戻り値
Date オブジェクト。指定した日付の属する週の初日。
例
以下の例は、特定の日付に戻された週の値を示しています。
この関数は、入力した日付の属する年の初日の日付を戻します。
構文
パラメーター
日付
年の取得元である日付オブジェクト。
戻り値
Date オブジェクト。指定した日付の属する年の初日。
例
以下の例は、特定の日付に戻された年の値を示しています。
この関数は、指定した日付の月を戻します。指定するオプションに応じて、月の番号、完全な月の名前、または短縮した月の名前を戻します。月の名前はロケール固有です。
構文
パラメーター
日付
月の取得元である日付オブジェクト。
オプション
Integer 型。オプション。戻す月の形式を表す番号です。以下のいずれかの値を使用します。
この引数を省略した場合、関数は月を番号で戻します。
戻り値
String 型。指定した日付の月。
例
以下の例は、特定の日付に戻された月の値を示しています。
以下の例は、現在日付の月を戻します。
この関数は、現在日付と時刻を戻します。例、Feb 2, 2009 2:05 PM。
構文
戻り値
Date オブジェクト。現在日付と時刻。
例
以下の例は、現在日付と時刻からクリスマスまでの時間数を戻します。
この関数は、指定した日付が入る四半期を表す番号 (1 から 4) を戻します。最初の四半期は 1 月 1 日に始まります。
構文
パラメーター
日付
四半期番号の取得元である日付オブジェクト。
戻り値
Integer 型。指定した日付の四半期番号。
例
以下の例は、特定の日付に戻された四半期番号を示しています。
以下の例は、CloseDate フィールドの各値の四半期番号を戻します。
以下の例は、現在日付の四半期番号を戻します。
この関数は、現在日付を戻します。この日付には午前 0 時の時刻値が含まれます。例、Feb 2, 2009 12:00 AM。
構文
戻り値
Date オブジェクト。現在日付と午前 0 時の時刻値。
例
以下の例は、現在日付からクリスマスまでの日数を戻します。
以下の例は、HireDate データ・フィールドの値から現在日付までの年数を計算します。
この関数は、指定した日付の週番号を表す数値 (1 から 52) を戻します。
構文
パラメーター
日付
週番号の取得元である日付オブジェクト。
戻り値
Integer 型。指定した日付の週番号。
例
以下の例は、特定の日付に戻された週番号を示しています。
以下の例は、CloseDate フィールドの各値の週番号を戻します。
以下の例は、現在日付の週番号を戻します。
この関数は、指定した日付の曜日を戻します。指定するオプションに応じて、曜日の番号、完全な曜日の名前、または短縮した曜日の名前が戻されます。曜日の名前はロケール固有です。
構文
パラメーター
日付
曜日の取得元である日付オブジェクト。
オプション
Integer 型。オプション。戻す形式を表す番号です。以下のいずれかの値を使用します。
この引数を省略した場合、オプション 1 を指定したと見なされます。
戻り値
String 型。指定した日付の曜日。
例
以下の例は、特定の日付に戻された曜日を示しています。
以下の例は、現在日付の曜日を戻します。
この関数は、指定した日付の 4 桁の年の値を戻します。例えば、日付が 2009-01-19 の場合、2009 を戻します。
構文
パラメーター
日付
年の取得元である日付オブジェクト。
戻り値
Integer 型。指定した日付の 4 桁の年。
例
以下の例は、HireDate フィールドの各値の年を戻します。
以下の例は、現在日付の年を戻します。