System.DateUtils.TryEncodeDayOfWeekInMonth

De RAD Studio API Documentation
Aller à : navigation, rechercher

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

Propriétés

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

Description

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

TryEncodeDayOfWeekInMonth renvoie un TDateTime pour la date spécifiée par les paramètres AYear, AMonth, ANthDayOfWeek et ADayOfWeek. La partie heure de la valeur renvoyée est 0 (minuit au début du jour spécifié).

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

ANthDayOfWeek indique l'occurrence du jour de la semaine représenté par ADayOfWeek. Il peut avoir toute valeur entre 1 et 5 (compris), sous réserve que cette valeur spécifie une date valide. Par exemple, si un mois n'inclut pas 5 lundis, l'affectation de la valeur 5 à ANthDayOfWeek et de 1 à ADayOfWeek provoquera le renvoi de F false par TryEncodeDayOfWeekInMonth.

ADayOfWeek représente le jour de la semaine avec 1 pour lundi et 7 pour dimanche.

TryEncodeDayOfWeekInMonth renvoie true si AYear, AMonth, ANthDayOfWeek et ADayOfWeek représentent une date valide, false si cette combinaison ne correspond pas à une date valide.

Remarque :  La définition de ADayOfWeek respecte le standard ISO 8601.

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

Voir aussi