System.DateUtils.TryEncodeDateMonthWeek

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function TryEncodeDateMonthWeek(const AYear, AMonth, AWeekOfMonth,
ADayOfWeek: Word; var AValue: TDateTime): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall TryEncodeDateMonthWeek(const System::Word AYear, const System::Word AMonth, const System::Word AWeekOfMonth, const System::Word ADayOfWeek, System::TDateTime &AValue);

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 Tag einer Woche im angegebenen Monat und Jahr repräsentiert.

TryEncodeDateMonthWeek berechnet den TDateTime-Wert für das Datum, das in den Parametern AYear, AMonth, AWeekOfMonth und ADayOfWeek übergeben wird.

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

AMonth gibt einen Monat an. Zulässig sind Werte zwischen 1 und 12 (inklusive).

AWeekOfMonth ist die Woche im Monat. Woche 1 ist die erste Woche mit vier oder mehr Tagen im betreffenden Monat. Ist der erste Kalendertag des Monats ein Freitag, Samstag oder Sonntag, muss der betreffende Tag durch Übergeben des vorherigen Monats in AMonth und der Gesamtzahl der Wochen im vorhergehenden Monat in AWeekOfMonth angegeben werden. Entsprechendes gilt am Monatsende. Ist der letzte Tag des Monats ein Montag, Dienstag oder Mittwoch, geben Sie für AMonth den Folgemonat und für AWeekOfMonth den Wert 1 an.

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

TryEncodeDateMonthWeek gibt true zurück, wenn AYear, AMonth, AWeekOfMonth und ADayOfWeek ein gültiges Datum repräsentieren. Liegt einer der Parameter nicht im gültigen Bereich, 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