System.DateUtils.TryEncodeDayOfWeekInMonth

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function TryEncodeDayOfWeekInMonth(const AYear, AMonth,
ANthDayOfWeek, ADayOfWeek: Word; out AValue: TDateTime): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall TryEncodeDayOfWeekInMonth(const System::Word AYear, const System::Word AMonth, const System::Word ANthDayOfWeek, const System::Word ADayOfWeek, /* out */ System::TDateTime &AValue);

プロパティ

種類 可視性 ソース ユニット
function public
System.DateUtils.pas
System.DateUtils.hpp
System.DateUtils System.DateUtils

説明

指定された月および年の中の,指定された曜日を表す TDateTime を計算します。

TryEncodeDayOfWeekInMonth 関数は,AYear,AMonth,ANthDayOfWeek,および ADayOfWeek パラメータで指定された日付を表す TDateTime を返します。戻り値の時刻部分は 0(指定された日の午前 0 時)です。

AYear は,年です。値の範囲は 1 ~ 9999(1 と 9999 を含む)です。

AMonth は,月です。値の範囲は 1 ~ 12(1 と 12 を含む)です。

ANthDayOfWeek は,ADayOfWeek で表された曜日の順序を示します。有効な値の範囲は 1 ~ 5 です。ただし,有効な日付の必要があります。たとえば,月に月曜が 4 回までしかない場合,ANthDayOfWeek を 5 に設定し,ADayOfWeek を 1 に設定すると,TryEncodeDayOfWeekInMonth は Ffalse を返します。

ADayOfWeek は曜日です。1 は月曜,7 は日曜を示します。

TryEncodeDayOfWeekInMonth は,AYear,AMonth,ANthDayOfWeek,および ADayOfWeek が有効な日付を表す場合に true を返し,無効な日付の場合は false を返します。

メモ:  ADayOfWeek の定義は,ISO 8601 規格に基づいています。

ヒント:  ADayOfWeek 値をよりわかりやすくするには,曜日定数 constants を使用します。

関連項目