Fonction de script : Retourne l'heure courante du jour au début du traitement du script.
SYS_TIME([Format de l'heure], [Fuseau horaire])
Syntaxe |
Description / format |
---|---|
Format de l'heure |
Format de l'heure récupérée. |
Fuseau horaire |
Nom d'un objet fuseau horaire ou mot clé UTC. |
Code retour |
---|
Heure actuelle au format indiqué. |
La fonction de script détermine la date courante. Un fuseau horaire saisi en paramètre est pris en compte.
Le format de l'heure est facultatif. Il sert à déterminer le format dans lequel la fonction doit renvoyer sa valeur. Si vous n'avez pas indiqué de format d'heure, le format par défaut "HHMMSS" est utilisé.
Le fuseau horaire est également facultatif. Si la fonction de script est exécutée sans ce paramètre, le fuseau horaire de l'objet est utilisé ou celui du client si aucun fuseau horaire n'a été défini pour cet objet. Si un fuseau horaire non défini a été indiqué, la valeur par défaut (fuseau horaire du client) est utilisée. Au lieu d'un fuseau horaire, vous pouvez également utiliser un mot clé UTC. L'heure est renvoyée directement en UTC (temps universel coordonné).
L'heure courante est déterminée et "figée" au début du traitement du script. La cohérence du script est ainsi assurée. Si vous utilisez plusieurs fois la fonction de script au sein d'un script, la même heure est toujours renvoyée. Cela s'applique en particulier lorsque le traitement du script est interrompu par une instruction :WAIT pour une durée donnée.
Pour transmettre l'heure courante à un objet variable de type "horodatage" avec l'instruction :PUT_VAR, il faut utiliser le format d'heure "HHMMSS" (valeur par défaut) ou "HH-MM-SS". Ce format est perdu après l'enregistrement de la variable sur systèmes Windows. L'affichage de la date se base alors sur les paramètres régionaux du panneau de configuration de Windows.
L'heure ne peut être enregistrée en même temps que la date que dans une variable de type "horodatage". Seules les combinaisons de formats de date et d'heure suivantes sont autorisées : "AAMMJJ HHMMSS" (par défaut), "AAAA-MM-JJ" et "AAAAMMJJ HHMMSS".
Le premier exemple détermine l'heure courante et transmet la valeur à une variable de script. Le fuseau horaire défini pour l'heure d'Europe centrale est utilisé. Le résultat est écrit dans le protocole d'activation.
:SET &TIME# = SYS_TIME("HH:MM:SS","TZ.MEZ")
:PRINT &TIME#
Dans le deuxième exemple, un terme spécial est utilisé et transmis par une variable de script. Il définit uniquement les secondes de l'heure courante.
:SET &FORMAT# = "SS"
:SET &TIME# = SYS_TIME(&FORMAT#)
Si la fonction est utilisée sans indication de format d'heure ni de fuseau horaire, la syntaxe est celle de l'exemple suivant.
:IF SYS_TIME()
= "120000"
!...
:ENDIF
Le troisième exemple détermine les date et heure courantes et les enregistre dans un objet variable de type "horodatage". Les valeurs par défaut s'appliquent aux formats de date et d'heure.
:SET &DATE# = SYS_DATE()
:SET &TIME# = SYS_TIME()
:PUT_VAR ENTRY
DATE, , "&DATE# &TIME#"
Rubriques connexes :
Elément de script | Description |
---|---|
SYS_TIME_PHYSICAL | Définit l'heure actuelle du jour. |
SYS_TIMESTAMP_PHYSICAL | Indique la date et l'heure actuelles. |
Eléments de script - Date et heure
Généralités sur les scripts
Eléments de script - Liste alphabétique
Eléments de script - Répartition fonctionnelle