FormatNumber, fonction

Microsoft VBScript

Microsoft® Visual Basic® Scripting Edition FormatNumber, fonction Référence du langage 
Version 2 


Description
Renvoie une expression formatée sous forme de nombre.
Syntaxe
FormatNumber(Expression[,NumDigitsAfterDecimal [,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])

La syntaxe de la fonction FormatNumber comprend les éléments suivants:

élément Description
Expression Expression à formater.
NumDigitsAfterDecimal Facultatif. Valeur numérique indiquant combien de positions à droite de la décimale sont affichées. La valeur par défaut (-1) indique que les paramètres régionaux de l'ordinateur sont employés.
IncludeLeadingDigit Facultatif. Constante 3-états indiquant si un zéro non significatif est affiché pour les valeurs décimales. Reportez-vous à la section Valeurs.
UseParensForNegativeNumbers Facultatif. Constante 3-états indiquant s'il faut placer ou non les valeurs négatives entre parenthèses. Reportez-vous à la section Valeurs.
GroupDigits Facultatif. Constante 3-états indiquant si les nombres doivent être regroupés ou non à l'aide du symbole de groupement spécifié dans le Panneau de configuration. Reportez-vous à la section Valeurs.

Valeurs
Les arguments IncludeLeadingDigit, UseParensForNegativeNumbers et GroupDigits prennent les valeurs suivantes:

Constante Value Description
TristateTrue -1 True
TristateFalse  0 False
TristateUseDefault -2 Utilise la valeur des paramètres régionaux de l'ordinateur.

Notes
Lorsqu'un ou plusieurs des arguments facultatifs sont omis, les valeurs de ces arguments sont fournies par les paramètres régionaux de l'ordinateur.

Remarque  Tous les paramètres sont issus de l'onglet Nombre des Paramètres régionaux.

L'exemple ci-dessous utilise la fonction FormatNumber pour formater un nombre avec quatre décimales :

Function FormatNumberDemo
  Dim MyAngle, MySecant, MyNumber
  MyAngle = 1.3                ' Définir l'angle en radians.
  MySecant = 1 / Cos(MyAngle)  ' Calculer la sécante.
  FormatNumberDemo = FormatNumber(MySecant,4) ' Formater Mycant avec quatre décimales
End Function