LSCurrencyFormat()

Formats a number in a locale-specific currency format.

LSCurrencyFormat( number=object, type=string, locale=locale, useBrackets=boolean );

Returns: String

Argument Description Default
number
object, required

Currency value

Alias: currency_number
type
string, optional
  • local: the currency format and currency symbol used in the locale.
  • international: the international standard currency format and currency symbol of the locale.
  • none: the currency format used in the locale without a currency symbol.

local
locale
locale, optional

Locale to use instead of the locale of the page when processing the function
useBrackets
boolean, optional

When a number is negative, by default, it is wrapped in brackets

Introduced: 7.0.0.177

true

Examples

  amount = 100;

  locale = 'en_US';
  writeoutput(LSCurrencyFormat( amount, 'local', locale )); // $100.00
  writeoutput(LSCurrencyFormat( amount, 'international', locale )); // USD 100.00
  writeoutput(LSCurrencyFormat( amount, 'none', locale )); // 100.00

  locale = 'ja_JP';
  writeoutput(LSCurrencyFormat( amount, 'local', locale )); // ￥100
  writeoutput(LSCurrencyFormat( amount, 'international', locale )); // JPY 100
  writeoutput(LSCurrencyFormat( amount, 'none', locale )); // 100

See also