【機能】
数値形式の文字列に書式設定して返す文字列処理関数です。
【構文】
FormatNumber(Expression [,NumDigitsAfterDecimal [,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]])
| 引数 |
内容 |
| Expression |
必ず指定します。書式を変換する式を指定します。 |
| NumDigitsAfterDecimal |
省略可能です。小数点以下に表示する桁数を表す数値を指定します。既定値は -1 で、[地域のプロパティ] の値を使用します。 |
| IncludeLeadingDigit |
省略可能です。小数点の左側のゼロを表示するかどうかを表す定数を指定します。設定する値については、次の「設定値」を参照してください。 |
| UseParensForNegativeNumbers |
省略可能です。負の値をかっこで囲むかどうかを表す定数を指定します。設定する値については、次の「設定値」を参照してください。 |
| GroupDigits |
省略可能です。[コントロール パネル] で指定されている桁区切り記号を使用して、数値を区切るかどうかを表す定数を指定します。設定する値については、次の「設定値」を参照してください。 |
IncludeLeadingDigit、UseParensForNegativeNumbers、および GroupDigits の各引数の設定値は次のとおりです。
| 定数 |
値 |
内容 |
| TristateTrue |
-1 |
True |
| TristateFalse |
0 |
False |
| TristateUseDefault |
-2 |
[地域のプロパティ] の設定値を使用します。 |
【解説】
引数を省略すると、[地域のプロパティ] の対応する値を使用します。
次のコードは、FormatNumber 関数を使い数字を小数点以下 4 桁まで表すよう設定する例です。
Function FormatNumberDemo
Dim MyAngle, MySecant, MyNumber
MyAngle = 1.3 ' 角度をラジアンで定義します。
MySecant = 1 / Cos(MyAngle) ' セカントを計算します。
FormatNumberDemo = FormatNumber(MySecant,4) ' MySecant を小数点以下 4 桁まで表示するよう設定します。
End Function
【必要条件】
バージョン 2