Description
Converts a locale-specific currency string into a formatted number. Attempts conversion by comparing the string with each the three supported currency formats (none, local, international) and using the first that matches.
Returns
A formatted number (string representation of a number) that matches the value of the parameter.
Category
Syntax
LSParseCurrency(currency [, locale])
See also
LSParseEuroCurrency, LSCurrencyFormat, LSEuroCurrencyFormat, LSIsCurrency; Locale-specific content in the Developing ColdFusion Applications
History
- ColdFusion (2018 release): Introduced named parameters.
- ColdFusion 8: Added the locale parameter.
- ColdFusion MX: Changed formatting behavior: this function might return different formatting than in earlier releases. This function uses Java standard locale formatting rules on all platforms.
Parameters
Parameter |
Description |
|---|---|
currency |
A locale-specific string a variable that contains one |
locale |
Locale to use instead of the locale of the page when processing the function |
Usage
This function uses the locale formatting rules of the JVM (specified in the ColdFusion Administrator Java and JVM page) on all platforms. These rules changed between Sun JVM 1.3.1 and JVM 1.4.1:
- JVM 1.3.1 requires that the local and international versions of currencies of countries in the Euro zone be formatted using the older, country-specific designations, such as 100.000,00 DM or DEM100.000,00 for the German (Standard) locale. Use the LSParseEuroCurrency function to parse euro currencies in these locales with JVM 1.3.1.
JVM 1.4.1 requires that currencies for Euro zone countries be expressed as euros; for example 100.000,00 BADCHAR or EUR100.000,00.
Note: The LSIsCurrency function always returns True if the locale is in the Euro currency zone and the currency is expressed in euros, including when using JVM 1.3.1. As a result, with older JVMs, LSIsCurrency does not ensure that LSParseCurrency returns a value.
To set the default display format of date, time, number, and currency values, use the SetLocale function. For a list of the locale-specific formats used to parse the currency, see LSCurrencyFormat.
Example
<cfscript>
currency="$125"
locale=getLocale()
writeOutput("Locale is: " & locale & "<br/>")
writeOutput(LSParseCurrency(currency,locale))
</cfscript>
Output
Locale is: English (US)
125.0