System.DateUtils.TryEncodeDateWeek

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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));

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
System.DateUtils.pas
System.DateUtils.hpp
System.DateUtils System.DateUtils

Beschreibung

Berechnet den TDateTime-Wert, der einen angegebenen Tag in einer angegebenen Woche im angegebenen Jahr repräsentiert.

TryEncodeDateWeek berechnet den TDateTime-Wert für das mit den Parametern AYear, AWeekOfYear und ADayOfWeek angegebene Datum.

AYear ist das Jahr. Zulässig sind Werte zwischen 1 und 9999 (inklusive).

AWeekOfYear gibt die Woche im Jahr an. Der Wert 1 bezeichnet die erste Woche, die mit mehr als vier Tagen im betreffenden Jahr liegt. Ist der erste Kalendertag des Jahres ein Freitag, Samstag oder Sonntag, muss der betreffende Tag durch Einstellen des vorherigen Jahres in AYear und der Gesamtzahl der Wochen im vorhergehenden Jahr in AWeekOfYear angegeben werden. Entsprechendes gilt am Ende des Jahres: Ist der letzte Tag ein Montag, Dienstag oder Mittwoch, kann der betreffende Tag ausgedrückt werden, indem Sie für AYear das folgende Jahr und für AWeekOfYear den Wert 1 angeben.

ADayOfWeek ist der Wochentag (1 für Montag, 2 für Dienstag usw.).

AValue gibt das angegebene Datum als TDateTime-Wert zurück. Der Zeitanteil von AValue ist 0 (Anfang des angegebenen Tages (Mitternacht)).

TryEncodeDateWeek gibt True zurück, wenn AYear, AWeekOfYear und ADayOfWeek ein gültiges Datum repräsentieren. Liegt einer dieser Parameter außerhalb des gültigen Bereichs, wird False zurückgegeben.

Anmerkung:  Die Definitionen für AWeekOfYear und ADayOfWeek entsprechen dem ISO-Standard 8601.

Tipp:  Mithilfe der Wochentagkonstanten können Sie die Aussagekraft des Rückgabewertes verbessern.

Siehe auch

Codebeispiele