System.DateUtils.TryEncodeDayOfWeekInMonth

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

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

Eigenschaften

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

Beschreibung

Berechnet den TDateTime-Wert, der ein bestimmtes Vorkommen eines Wochentags im angegebenen Monat und Jahr repräsentiert.

TryEncodeDayOfWeekInMonth gibt einen TDateTime-Wert für das Datum zurück, das in den Parametern AYear, AMonth, ANthDayOfWeek und ADayOfWeek übergeben wird. Der Zeitanteil des Rückgabewertes ist 0 (Mitternacht des angegebenen Tages).

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

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

ANthDayOfWeek gibt das Vorkommen des von ADayOfWeek repräsentierten Wochentags an. Zulässig sind Werte zwischen 1 und 5 (inklusive). Der Wert muss ein gültiges Datum ergeben. Wenn Sie beispielsweise für ANthDayOfWeek den Wert 5 und für ADayOfWeek den Wert 1 angeben, obwohl der betreffende Monat nur vier Montage enthält, gibt TryEncodeDayOfWeekInMonth F False zurück.

ADayOfWeek ist der Wochentag (1 für Montag, 7 für Sonntag).

TryEncodeDayOfWeekInMonth gibt True zurück, wenn die Parameter AYear, AMonth, ANthDayOfWeek und ADayOfWeek ein gültiges Datum repräsentieren. Ist dies nicht der Fall, wird False zurückgegeben.

Anmerkung:  Die Definition für ADayOfWeek entspricht dem ISO-Standard 8601.

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

Siehe auch

Codebeispiele