FormatCurrency

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

Structure

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

Parameters

Expression - Required. 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.

Parameter Values

The IncludeLeadingDigit, UseParensForNegativeNumbers, and GroupDigits Structure have the following values:

Constant Value Description

TristateTrue -1 True

TristateFalse 0 False

TristateUseDefault -2 Use the setting from the computer's regional settings.

Description

When one or more optional Structure are omitted, values for omitted Structure 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.

Note

All settings information comes from the Regional Settings Currency tab, except leading zero, which comes from the Number tab.

Example

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