VBScript FormatNumber Function

Returns an expression formatted as a number.

Syntax: VBScript FormatNumber Function

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

Arguments: VBScript FormatNumber Function

Expression

The expression to be formatted. Required.

NumDigitsAfterDecimal

A 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. Optional.

IncludeLeadingDigit

A tristate constant that indicates whether or not a leading zero is displayed for fractional values. See Settings section for values. Optional.

UseParensForNegativeNumbers

A tristate constant that indicates whether or not to place negative values within parentheses. See Settings section for values. Optional.

GroupDigits

A tristate constant that indicates whether or not numbers are grouped using the group delimiter specified in the control panel. See Settings section for values. Optional.

Settings: VBScript FormatNumber Function

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: VBScript FormatNumber Function

When one or more of the optional arguments are omitted, the values for omitted arguments are provided by the computer's regional settings.

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

Function FormatNumberDemo

Dim MyAngle, MySecant, MyNumber

MyAngle = 1.3 ' Define angle in radians.

MySecant = 1 / Cos(MyAngle) ' Calculate secant.

FormatNumberDemo = FormatNumber(MySecant,4) ' Format MySecant to four decimal places.

End Function

Note

On Windows systems, all settings information comes from the Regional Settings Number tab.