System.UnicodeString.FormatFloat

De RAD Studio API Documentation
Aller à : navigation, rechercher

C++

static UnicodeString FormatFloat(const UnicodeString& format,
                                            const long double& value);

Propriétés

Type Visibilité  Source Unité  Parent
function public ustring.h System UnicodeString

Description

Formate la valeur à virgule flottante donnée par value en utilisant la chaîne de format spécifiée par format.

Les spécificateurs de format reconnus dans la chaîne de format sont les suivants :



Spécificateur Signification
0 Emplacement d'un chiffre. Si la valeur formatée dispose d'un chiffre à la position du '0' dans la chaîne de format, ce chiffre est copié dans la chaîne en sortie. Sinon, un '0' est inclus à cette position dans la chaîne en sortie.
# Emplacement d'un chiffre. Si la valeur formatée dispose d'un chiffre à la position du '#' dans la chaîne de format, ce chiffre est copié dans la chaîne en sortie. Sinon, rien n'est inclus à cette position dans la chaîne en sortie.
. Séparateur décimal. Le premier caractère point ('.') dans la chaîne de format détermine l'emplacement du séparateur décimal dans la valeur formatée ; les caractères '.' supplémentaires sont ignorés. Le véritable caractère utilisé comme séparateur décimal dans la chaîne de sortie est déterminé par la variable globale DecimalSeparator. La valeur par défaut de DecimalSeparator est spécifiée dans la page Nombre de la section Paramètres régionaux du Panneau de configuration Windows.
, Séparateur des milliers. Si la chaîne de format contient un ou plusieurs caractères virgule (','), la sortie comporte des séparateurs de milliers insérés entre chaque groupe de trois chiffres à gauche de la virgule décimale. L'emplacement et le nombre de caractères virgule ',' dans la chaîne de format n'affectent pas la sortie, si ce n'est pour indiquer que l'on désire des séparateurs de milliers. Le caractère utilisé comme séparateur de milliers dans la sortie est déterminé par la variable globale ThousandSeparator dont la valeur par défaut est spécifiée dans la page Nombre de la section Paramètres régionaux du Panneau de configuration Windows.
E+ Notation scientifique. Si l'une des quatre chaînes 'E+', 'E-', 'e+' ou 'e-' est incluse dans la chaîne de format, le nombre est formaté en utilisant la notation scientifique. Un groupe de quatre caractères '0' au plus peut immédiatement suivre la chaîne 'E+', 'E-', 'e+' ou 'e-' afin de déterminer le nombre minimum de chiffres de l'exposant. Les spécificateurs de format 'E+' et 'e+' provoquent l'apparition d'un signe plus pour les exposants positifs et d'un signe moins pour les exposants négatifs. 'E-' et 'e-' ne provoquent l'apparition du signe que pour les exposants négatifs.
'xx'/"xx" Les caractères encadrés par des guillemets simples ou doubles sont renvoyés tels quels et n'affectent pas le format.
; Sépare les sections des nombres positifs, négatifs et nuls dans la chaîne de format.

Les emplacements du '0' le plus à gauche avant la virgule dans la chaîne de format et du '0' le plus à droite après cette même virgule déterminent l'étendue de chiffres qui seront toujours présents dans la chaîne en sortie.

Le nombre formaté est toujours arrondi en fonction du nombre de décimales prévues ('0' ou '#') à droite de la virgule dans la chaîne de format. Si cette dernière ne contient pas de séparateur décimal, la valeur formatée est arrondie au nombre entier le plus proche.

Si le nombre en cours de formatage a plus de chiffres à la gauche du séparateur décimal qu'il n'y a d'emplacements de chiffres à la gauche du caractère '.' dans la chaîne de formatage, les chiffres supplémentaires sont sortis avant le premier emplacement de chiffre.

Pour autoriser des formats différents pour les valeurs positives, négatives et nulles, la chaîne de format peut contenir entre une et trois sections séparées par des points-virgules :

  • Une section : la chaîne de format s'applique à toutes les valeurs.
  • Deux sections : la première section s'applique aux valeurs positives et nulles et la deuxième aux valeurs négatives.
  • Trois sections : la première section s'applique aux valeurs positives, la deuxième aux valeurs négatives, et la troisième aux valeurs nulles.

Si aucun formatage n'est spécifié pour les valeurs positives, celles-ci sont formatées en utilisant le format général des nombres à virgule flottante avec 15 chiffres significatifs, ce qui correspond à un appel à FloatToStrF avec le format sffGeneral. Ce type de format est également utilisé si la valeur dispose de plus de 18 chiffres à gauche du séparateur décimal et si la chaîne de format n'indique pas la notation scientifique.

Le tableau ci-dessous montre quelques exemples de formats et les résultats obtenus quand ces formats sont appliqués à différentes valeurs :

Chaîne de format- 1234 -1234 0.5 0
1234 -1234 0.5 0
0 1234 -1234 1
0.00 1234.00 -1234.00 0.50
#,## 1234 -1234 ,5
#,##0.00 1,234.00 -1,234.00 0.50
#,##0.00;(#,##0.00) 1,234.00 (1,234.00) 0.50
#,##0.00;;Zéro 1,234.00 -1,234.00 0.50
0.000E+00 1.234E+03 -1.234E+03 5.000E-01
#.###E-0 1.234E3 -1.234E3 5E-1


Voir aussi