VBScript FormatCurrency Function

Returns an expression formatted as a currency value using the currency symbol defined in the system control panel.

Syntax: VBScript FormatCurrency Function

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

Arguments: VBScript FormatCurrency 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 computer's regional settings. See Settings section for values. Optional.

Settings: VBScript FormatCurrency Function

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits argument 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 FormatCurrency Function

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

The position of the currency symbol relative to the currency value is determined by the system's regional settings.

The following example uses the FormatCurrency function to format the expression as a currency and assign it to MyCurrency:

Dim MyCurrency

MyCurrency = FormatCurrency(1000) ' MyCurrency contains $1000.00.

Note

On Windows systems, all settings information comes from the Regional Settings Currency tab, except leading zero, which comes from the Number tab.