FIRST_OF_PERIOD

Fonction de script : Détermine le premier jour de la période pour une date donnée.

Syntaxe

FIRST_OF_PERIOD ([Date Format:]Date, Period Format[, Output Format[, Calendar, Calendar Event]])

Syntaxe	Description / format
Date
Period Format	Voir Formats de date, d'heure et de période dans les scripts.
Output Format	Format prédéfini de la date déterminée. Format : littéral de script ou variable de script Défaut : AAMMJJ
Calendar	Nom de l'objet Calendrier à prendre en compte pour le début de la période Format: Nom AE, littéral de script ou variable de script
Calendar Event	Nom de l'événement de calendrier à prendre en compte pour le début de la période Format: Nom AE, littéral de script ou variable de script

Codes retour
Date du début de la période au format indiqué. 20327 : L'objet Calendrier n'existe pas 20328 : L'événement de calendrier n'existe pas dans l'objet Calendrier 20456 : L'événement de calendrier n'inclut pas la date de début de période

La fonction de script détermine le premier jour de la période pour la date indiquée. La valeur retournée est une date.

La fonction de script récupère une date. Vous pouvez également spécifier un format de date particulier. Les formats de date par défaut à utiliser sont "AAMMJJ" ou "AAAAMMJJ". Deux points ou un point-virgule sont autorisés comme séparateur entre le format de date et la date.

Le type de période (année, trimestre, mois ou semaine) est défini par le format de période.

Le format de période spécial "WS" s'applique à cette fonction. Ce format indique que le dimanche est le premier jour de la semaine. "WW" au contraire indique que le lundi est le premier jour de la semaine.

Le format de sortie est optionnel. Si le format de sortie n'est pas utilisé, la fonction de script renvoie une date au format "AAMMJJ" par défaut. Remarque : Lorsque format de sortie n'est pas utilisé, mais que le calendrier et l'événement de calendrier sont spécifiés, vous devez utiliser des virgules.

Si vous utilisez des calendriers et des événements de calendrier, cette fonction de script renvoie le jour calendaire correct de la période. Si aucun jour n'est valide pour cette période, le résultat est une date nulle au format de date courant (par exemple : 0000-00-00).

Conseil : Utilisez l'instruction de script :ON_ERROR pour définir l'action à entreprendre en cas d'erreur. Pour plus d'informations, voir Éléments de script pour la gestion des erreurs.

Exemples

Le premier exemple détermine le premier jour de la semaine pour le 29.03.2000. Le résultat 27.03.00 (lundi) est affiché dans le rapport.

:SET &DATE# = FIRST_OF_PERIOD ("000329","WW","DD.MM.YY")
:PRINT &DATE#

Lorsque le format de période spécial "WS" est utilisé, 26.03.00 (dimanche) est écrit dans le rapport d'activation.

:SET &DATE# = FIRST_OF_PERIOD ("DD.MM.YY:29.03.00","WS","DD.MM.YY")
:PRINT &DATE#

Dans le troisième exemple, le dernier jour pertinent d'un trimestre est déterminé. Le format de sortie n'est pas pris en compte.

:SET &DATE# = FIRST_OF_PERIOD ("000329", "Q", , READINESS, WEEKDAY)
:PRINT &DATE#

Voir aussi :