FormatCurrency 函数 (Visual Basic)

2008-08-18

更新：2007 年 11 月

返回一个格式为货币值的表达式，该货币值使用系统控制面板中定义的货币符号。

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

参数

Expression
必选。要格式化的表达式。
NumDigitsAfterDecimal
可选。数值，指示在小数点右侧显示的位数。默认值是 -1，它表示使用计算机的区域设置。
IncludeLeadingDigit
可选。三态枚举，指示是否显示小数值的前导零。请参见“设置”了解具体的值。
UseParensForNegativeNumbers
可选。三态枚举，指示是否在括号内放置负值。请参见“设置”了解具体的值。
GroupDigits
可选。三态枚举，指示是否使用计算机的区域设置中指定的组分隔符对数字进行分组。请参见“设置”了解具体的值。

设置

IncludeLeadingDigit、UseParensForNegativeNumbers 和 GroupDigits 参数采用下列三态枚举值。

值	说明
TriState.True	True
TriState.False	False
TriState.UseDefault	计算机的区域设置

异常

异常类型	错误号	条件
ArgumentException	5	小数点后的数字位数大于 99。
InvalidCastException	13	类型不是数字。

如果正在升级使用无结构错误处理的 Visual Basic 6.0 应用程序，请参见“错误号”一列。（您可以根据 Number 属性（Err 对象）比较错误号。）然而，如果可能，应当考虑用 Visual Basic 的结构化异常处理概述替换这种错误控制。

备注

如果省略了一个或多个可选参数，则将改用计算机的匹配区域设置值。

货币符号相对于货币值的位置由系统的区域设置确定。

说明：
所有设置信息均来自应用程序的区域设置。默认情况下，这些信息是在控制面板中设置的区域设置。不过，可以通过使用 .NET Framework 以编程方式更改这些信息，来自 Number 选项卡的前导零除外。

示例

下面的示例演示了 FormatCurrency 函数的用法。

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