lSCurrencyFormat

Description

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

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.

Syntax

LSCurrencyFormat(number [, type, locale])

Attributes

Attribute	Description	Required	Default
locale	Locale to use instead of the locale of the page when processing the function
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

Returns

A formatted currency value.

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.

Example

<h3>LSCurrencyFormat Example</h3> 
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><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>

cfmldocs