System.DateUtils.TryEncodeDateWeek

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

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'une année spécifiés.

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

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

AWeekOfYear représente la semaine dans cette année, où 1 correspond à la première semaine d'au moins quatre jours. Si le premier jour calendaire de l'année est vendredi, samedi ou dimanche, ces trois jours doivent être exprimés en attribuant à AYear l'année antérieure et à AWeekOfYear le nombre de semaines comprises dans cette année antérieure. De même, si le dernier jour calendaire de l'année est lundi, mardi ou mercredi, ces trois jours sont exprimés en attribuant à AYear l'année suivante et à AWeekOfYear 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é).

TryEncodeDateWeek renvoie true si AYear, AWeekOfYear 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