System.DateUtils.TryEncodeDateMonthWeek

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

Propriétés

Type Visibilité  Source Unité  Parent
function public
System.DateUtils.pas
System.DateUtils.hpp
System.DateUtils System.DateUtils

Description

Calcule la valeur TDateTime qui représente un jour d'une semaine d'un mois et d'une année spécifiés.

TryEncodeDateMonthWeek calcule la valeur TDateTime pour la date spécifiée par les paramètres AYear, AMonth, AWeekOfMonth et ADayOfWeek.

AYear représente l'année. Il peut avoir toute valeur entre 1 et 9999 (compris).

AMonth représente le mois. Il peut avoir toute valeur entre 1 et 12 (compris).

AWeekOfMonth représente la semaine dans ce mois, où 1 correspond à la première semaine d'au moins quatre jours. Si le premier jour calendaire du mois est vendredi, samedi ou dimanche, ces trois jours doivent être exprimés en attribuant à AMonth le mois précédent et à AWeekOfMonth le nombre de semaines comprises dans ce mois précédent. De même, si le dernier jour calendaire du mois est lundi, mardi ou mercredi, ces trois jours sont exprimés en attribuant à AMonth le mois suivant et à AWeekOfMonth la valeur 1.

ADayOfWeek représente le jour de la semaine : 1 pour lundi, 2 pour mardi, etc.

AValue renvoie la date spécifiée sous forme d'une valeur TDateTime. La partie heure de AValue est 0 (minuit au début du jour spécifié).

TryEncodeDateMonthWeek renvoie true si AYear, AMonth, AWeekOfMonth et ADayOfWeek représentent une date valide, false si l'un de ces paramètres ne respecte pas la plage de valeurs admises.

Remarque :  Les définitions de AWeekOfYear et ADayOfWeek respectent la norme ISO 8601.

Conseil :  Pour faciliter la lecture de la valeur ADayOfWeek, utilisez les constantes des jours de la semaine.

Voir aussi