FormatCurrency 函式 (Visual Basic)

發行項
08/21/2008

更新：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
選擇項。指出是否要在分數值前面顯示零的 TriState 列舉型別 (Enumeration)。請參閱值的「設定」。
UseParensForNegativeNumbers
選擇項。TriState 列舉型別指出是否要將負值置於括號內。請參閱值的「設定」。
GroupDigits
選擇項。TriState 列舉型別指出是否要使用電腦區域設定中指定的群組分隔符號 (Delimiter) 來群組數字。請參閱值的「設定」。

設定

IncludeLeadingDigit、UseParensForNegativeNumbers 和 GroupDigits 引數會使用下列 TriState 列舉值。

值	描述
TriState.True	True
TriState.False	False
TriState.UseDefault	電腦的地區設定

例外狀況

例外狀況類型	錯誤代碼	條件
ArgumentException	5	小數點後的數字超過 99 個。
InvalidCastException	13	不是數字型別。

如果將使用非結構化錯誤處理的 Visual Basic 6.0 應用程式升級，請參閱「錯誤代碼」資料行 (您可以將錯誤代碼與 Number 屬性 (Err 物件) 比對)。但是，請盡可能考慮以 Visual Basic 的結構化例外處理概觀取代這類錯誤控制項。

備註

當省略一或多個選擇性引數時，會以電腦的相符區域設定值來代替使用。

與貨幣值相關的貨幣符號之位置是由系統的區域設定來決定。

注意事項：
所有設定資訊都來自於應用程式的地區設定 (Locale)。依預設，這是在 [控制台] 中設定的地區設定。不過，您也可使用 .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)