FormatCurrency 関数 (Visual Basic)

[アーティクル]
09/30/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
省略可能です。小数点の左側のゼロを表示するかどうかを表す列挙型を指定します。値については、「設定」を参照してください。
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)