System.DateUtils.TryEncodeDateWeek

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

Delphi

function TryEncodeDateWeek(const AYear, AWeekOfYear: Word; out AValue: TDateTime; const ADayOfWeek: Word): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall TryEncodeDateWeek(const System::Word AYear, const System::Word AWeekOfYear, /* out */ System::TDateTime &AValue, const System::Word ADayOfWeek = (System::Word)(0x1));

プロパティ

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

説明

指定された年の指定された週の指定された曜日を表す TDateTime 値を計算します。

TryEncodeDateWeek 関数は,AYear,AWeekOfYear,および ADayOfWeek パラメータで指定された日付を表す TDateTime 値を計算します。

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

AWeekOfYear は AYear 内の週です。1 は,少なくとも 4 日以上ある最初の週を示します。年の最初の日が金曜,土曜,または日曜である場合,その日は AYear を前年に設定し,AWeekOfYear を前年の週数に設定して表現する必要があります。同様に,年の最後の日が月曜,火曜,または水曜である場合,その日は AYear を次の年に設定し,AWeekOfYear を 1 に設定して表現します。

ADayOfWeek は曜日です。1 は月曜,2 は火曜を表します。

AValue は,指定された日付を TDateTime 値で返します。AValue の時刻部分は 0(指定された日の午前 0 時)です。

TryEncodeDateWeek は,AYear,AWeekOfYear,および ADayOfWeek が有効な日付を表す場合に true を返し,いずれかのパラメータが有効な範囲にない場合は false を返します。

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

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

関連項目