FormatCurrency, fonction (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne une expression sous forme de valeur monétaire utilisant le symbole monétaire défini dans le Panneau de configuration du système.

Function FormatCurrency(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

Paramètres

Expression
Requis. Expression à formater.
NumDigitsAfterDecimal
Facultatif. Valeur numérique indiquant le nombre de décimales affichées. La valeur par défaut est –1, ce qui indique que les paramètres régionaux de l'ordinateur sont utilisés.
IncludeLeadingDigit
Facultatif. Énumération TriState (3 états) indiquant si un zéro non significatif s'affiche pour les valeurs décimales. Consultez la section « Paramètres » pour obtenir les valeurs.
UseParensForNegativeNumbers
Facultatif. Énumération TriState (3 états) indiquant si les valeurs négatives doivent être mises entre parenthèses. Consultez la section « Paramètres » pour obtenir les valeurs.
GroupDigits
Facultatif. Énumération TriState (3 états) indiquant si les nombres doivent ou non être regroupés en utilisant le délimiteur de groupe spécifié dans les paramètres régionaux de l'ordinateur. Consultez la section « Paramètres » pour obtenir les valeurs.

Paramètres

Les arguments IncludeLeadingDigit, UseParensForNegativeNumbers et GroupDigits prennent les valeurs d'énumération TriState suivantes.

Valeur	Description
TriState.True	True
TriState.False	False
TriState.UseDefault	Paramètres régionaux de l'ordinateur

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Le nombre de chiffres après la virgule est supérieur à 99.
InvalidCastException	13	Le type n'est pas numérique.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Quand un ou plusieurs arguments facultatifs sont omis, les valeurs sont fournies par les paramètres régionaux correspondants de l'ordinateur.

La position du symbole monétaire par rapport à la valeur monétaire est déterminée par les paramètres régionaux du système.

Remarque :
Tous les paramètres sont issus des paramètres régionaux de l'application. Par défaut, il s'agit des paramètres régionaux définis dans le Panneau de configuration. Toutefois, ceux-ci peuvent être modifiés par programme à l'aide du .NET Framework, à l'exception du zéro non significatif, qui est un paramètre défini dans l'onglet Number.

Exemple

L'exemple ci-dessous illustre l'utilisation de la fonction FormatCurrency.

Dim TestDebt As Double = -4456.43
Dim TestString As String
' Returns "($4,456.43)".
TestString = FormatCurrency(TestDebt, , , TriState.True, TriState.True)