Manuel des Scripts Automation Engine > Organisation fonctionnelle > Chaînes de caractères > FORMAT

FORMAT

Fonction de script : Modifie le formatage d'un nombre.

Syntaxe

FORMAT(Number, [Format])

Syntaxe

Description / format

Nombre

Nombre devant être formaté.
Format : littéral de script ou variable de script

Format

Zéros servant de caractères de remplacement pour le nmobre de chiffres. Pour les nombres à virgule flottante, vous pouvez aussi spécifier un point décimal comme séparateur et le nombre de chiffres après la virgule.
Format : littéral de script ou variable de script
Valeur par défaut : 0  


Codes retour

Nombre sans zéros en tête.
Nombre avec zéros en tête.

Remarques

La fonction de script permet d'ajouter ou de supprimer des zéros en tête d'un nombre entier. Pour les nombres à virgule flottante, il est possible de déterminer le nombre de chiffres après la virgule. Pour cela, définissez un point décimal comme séparateur dans le paramètre Format. Le nombre de zéros que vous indiquez après le séparateur représente le nombre de décimales. Les nombres qui dépassent le format spéficié sont tronqués. Les résultats ne sont pas arrondis. Si vous ne spécifiez pas de point décimal, toutes les décimales sont supprimées. Si le nombre comporte mpoins de décimales que spécifié dans le paramètre Format, le reste est complété par des zéros.

Le nombre de zéros en tête des nombres entiers peut aussi être spécifié dans le paramètre Format. Le nombre de zéros présenté dans ce paramètre sert de caractères de remplacement pour le nombre total de chiffres. Si vous utilisez moins de chiffres que spécifié, la valeur est inchangée. Les zéros à en tête seront supprimés si vous n'utilisez pas ce paramètre.

Si vous spécifiez aussi le caractère "+" en tant que premier caractère dans Format (comme dans "+0.00"), le signe algébrique sera également affiché pour les chiffres positifs. 

La variable de destination à laquelle le code retour de la fonction est attribué doit comporter le type de données "chaîne".

Si le résultat est nul après la suppression de toutes les décimales, le signe algébrique n'a alors plus d'importance et est supprimé.

 

Exemples

Le premier exemple supprime les zéros en tête du code retour à 16 chiffres d'une fonction de script. Le résultat s'affiche dans le protocole d'activation.

:SET &SRV#=SYS_BUSY_60()
:
SET &RET#=FORMAT(&SRV#)
:
PRINT &RET#

Dans le deuxième exemple, le nombre à 5 chiffres indiqué est formaté. Le résultat (00125) s'affiche dans le protocole d'activation.

:SET &RET#=FORMAT("125","00000")
:
PRINT &RET#

Dans le troisième exemple, les zéros en tête sont supprimés car le nombre de chiffres indiqué est incorrect (trop petit). Le résultat (333) s'affiche dans le protocole d'activation.

:SET &RET#=FORMAT("0000333","00")
:
PRINT &RET#

Dans le quatrième exemple, le nombre n'est pas modifié.

:SET &RET#=FORMAT("555","00")
:
PRINT &RET#

The fifth example shows the formatting of a floating-point number to one position after the decimal point. "-0.7" is output in the activation protocol. 

:DEFINE &NUM#,float
:DEFINE &RET#,string
:SET &NUM#=-0.75
:
SET &RET#=FORMAT(&NUM#,"00.0")
:
PRINT &RET#

Dans le sixième exemple, les décimales sont supprimées. L'affichage dans le rapport d'activation est "0000".

:DEFINE &NUM#,float
:DEFINE &RET#,string
:SET &NUM#=0.65
:
SET &RET#=FORMAT(&NUM#,"0000")
:
PRINT &RET#

 

Rubriques connexes :

Elément de script Description

STR_LTRIM

Supprime les espaces qui figurent au début d'une chaîne de caractères.

STR_RTRIM

Supprime les espaces qui figurent à la fin d'une chaîne de caractères.

Eléments de script - Chaînes

Généralités sur les scripts
Eléments de script - Liste alphabétique

Eléments de script - Répartition fonctionnelle