FormatNumber Function

Returns a FixStr value formatted as a number.

Syntax

FormatNumber([Expression[,NumDigitsAfterDecimal [,IncludeLeadingDigit [,UseParensForNegativeNumbers [,GroupDigits]]]]])

If the Expression argument is omitted, is a non-initialized variable, or Null, the function returns 0.

The FormatNumber function syntax has these parts:

Part Description
Expression Optional. Expression to be formatted.
NumDigitsAfterDecimal Optional. Numeric value indicating how many places to the right of the decimal are displayed. Default value is -1, which indicates that the computer's regional settings are used.
IncludeLeadingDigit Optional. Tristate constant that indicates whether or not a leading zero is displayed for fractional values. See Settings section for values.
UseParensForNegativeNumbers Optional. Tristate constant that indicates whether or not to place negative values within parentheses. See Settings section for values.
GroupDigits Optional. Tristate constant that indicates whether or not numbers are grouped using the group delimiter specified in the computer's regional settings. See Settings section for values.

Settings

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits arguments have the following settings:

Constant Value Description
TristateTrue -1 True
TristateFalse  0 False
TristateUseDefault -2 Use the setting from the computer's regional settings.

Remarks

When one or more optional arguments are omitted, the values for omitted arguments are provided by the computer's regional settings. If the expression argument is omitted, it's value is considered 0.

Note   All settings information comes from the Regional Settings Number tab. In expression point (.) is used as decimal separator.

Example

The following example uses the FormatNumber function to format a number to have four decimal places:

Dim MyAngle, MySecant, MyNumber
MyAngle = 1.3   ' Define angle in radians.
MySecant = 1 / Cos(MyAngle)   ' Calculate secant.
MyNumber = FormatNumber(MySecant,4)    ' Format MySecant to four decimal places.

 

See Also

Format Function, FormatDateTime Function