LSCurrencyFormat

Description

Formats a number in a locale-specific currency format. For countries that use the euro, the result depends on the JVM.

Returns

A formatted currency value.

Category

Display and formatting functions, International functions

Function syntax

LSCurrencyFormat(number [, type, locale])

See also

LSEuroCurrencyFormat, LSIsCurrency, LSParseCurrency, LSParseEuroCurrency, SetLocale; Handling data in ColdFusion in the Developing ColdFusion Applications

History

ColdFusion 8: Added the locale parameter.

ColdFusion MX: Changed formatting behavior: this function might return different formatting than in earlier releases. If a negative number is passed to it, it returns a negative number. If type = "local", it returns the value in the current locale’s standard format. If type = "international", it returns the value in the current locale’s international standard format. This function uses Java standard locale formatting rules on all platforms.

Parameters

Parameter

Description

number

Currency value

type

  • local: the currency format and currency symbol used in the locale.

- With JDK 1.3, the default for Euro Zone countries is their local currency.

- With JDK 1.4, the default for Euro Zone countries is the euro.

  • international: the international standard currency format and currency symbol of the locale.

  • none: the currency format used in the locale; no currency symbol

locale

Locale to use instead of the locale of the page when processing the function

Usage

This function uses Java standard locale formatting rules on all platforms.

Note: With a Sun 1.3.1-compliant JVM, use the LSEuroCurrencyFormat function to format euro currency values.

Currency output

The following table shows sample currency output. For locales that use Euro, the Local and International columns contains two entries. The first is entry is the result with a Sun the 1.4.1 or later compliant JVM, the second entry is the result with a 1.3.1-compliant JVM.

Locale

Type = Local

Type = International

Type = None

Chinese (China)

¥100,000.00

CNY100,000.00

100,000.00

Chinese (Hong Kong)

HK$100,000.00

HKD100,000.00

100,000.00

Chinese (Taiwan)

NT$100,000.00

TWD100,000.00

100,000.00

Dutch (Belgian)

100.000,00 €

100.000,00 BF

BEF100.000,00

EUR100.000,00

100.000,00

Dutch (Standard)

€ 100.000,00

fl 100.000,00

NLG100.000,00

EUR100.000,00

100.000,00

English (Australian)

$100,000.00

AUD100,000.00

100,000.00

English (Canadian)

$100,000.00

CAD100,000.00

100,000.00

English (New Zealand)

$100,000.00

NZD100,000.00

100,000.00

English (UK)

£100,000.00

GBP100,000.00

100,000.00

English (US)

$100,000.00

USD100,000.00

100,000.00

French (Belgian)

100.000,00 €

100.000,00 FB

EUR100.000,00

BEF100.000,00

100.000,00

French (Canadian)

100 000,00 $

CAD100 000,00

100 000,00

French (Standard)

100 000,00 €

100 000,00 F

EUR100 000,00

FRF100 000,00

100 000,00

French (Swiss)

SFr. 100'000.00

CHF100'000.00

100'000.00

German (Austrian)

€ 100.000,00

öS 100.000,00

EUR100.000,00

ATS100.000,00

100.000,00

German (Standard)

100.000,00 €

100.000,00 DM

EUR100.000,00

DEM100.000,00

100.000,00

German (Swiss)

SFr. 100'000.00

CHF100'000.00

100'000.00

Italian (Standard)

€ 100.000,00

L. 10.000.000

EUR10.000.000

ITL10.000.000

10.000.000

Italian (Swiss)

SFr. 100'000.00

CHF100'000.00

100'000.00

Japanese

¥100,000

JPY100,000

JPY100,000

Korean

W100,000

KRW100,000

100,000

Norwegian (Bokmal)

kr 100 000,00

NOK100 000,00

100 000,00

Norwegian (Nynorsk)

kr 100 000,00

NOK100 000,00

100 000,00

Portuguese (Brazilian)

R$100.000,00

BRC100.000,00

100.000,00

Portuguese (Standard)

100.000,00 €

R$100.000,00

EUR100.000,00

BRC100.000,00

100.000,00

Spanish (Mexican)

$100,000.00

MXN100,000.00

100,000.00

Spanish (Modern)

100.000,00 €

10.000.000 Pts

EUR10.000.000

ESP10.000.000

10.000.000

Spanish (Standard)

100.000,00 €

10.000.000 Pts

ESP10.000.000

EUR10.000.000

10.000.000

Swedish

100.000,00 kr

SEK100.000,00

100.000,00
Note: ColdFusion maps Spanish (Modern) to the Spanish (Standard) format.

To set the default display format of date, time, number, and currency values, use the SetLocale function.

Example

<h3>LSCurrencyFormat Example</h3> 
<p>LSCurrencyFormat returns a currency value using the locale  
    convention. Default value is "local." 
<!--- loop through list of locales; show currency values for 100,000 units ---> 
<cfloop LIST = "#Server.Coldfusion.SupportedLocales#" 
index = "locale" delimiters = ","> 
    <cfset oldlocale = SetLocale(locale)> 
    <cfoutput><p><b><I>#locale#</I></b><br> 
        Local: #LSCurrencyFormat(100000, "local")#<br> 
        International: #LSCurrencyFormat(100000, "international")#<br> 
        None: #LSCurrencyFormat(100000, "none")#<br> 
        <hr noshade> 
    </cfoutput> 
</cfloop>