Formats the date part of a date/time value in a locale-specific format.
A formatted date/time value. If no mask is specified, the value is formatted according to the locale setting of the client computer.
Date and time functions, Display and formatting functions, International functions
LSDateFormat(date
[,mask
,locale
])
LSParseDateTime, LSTimeFormat, DateFormat, SetLocale; "Handling data in ColdFusion" in the ColdFusion Developer's Guide
ColdFusion 8: Added the locale parameter.
ColdFusion MX:
mask
parameter options: short, medium, long, and full.
Parameter |
Description |
---|---|
date |
A date/time object, in the range 100 AD-9999 AD. |
mask |
Characters that show how ColdFusion displays the date:
The following conform to Java locale-specific time encoding standards. Their exact formats depend on the locale:
The default value is medium For more information on formats, see LSParseDateTime. |
locale |
Locale to use instead of the locale of the page when processing the function |
This function uses Java standard locale formatting rules on all platforms.
When passing date/time value as a string, enclose it in quotation marks. Otherwise, it is interpreted as a number representation of a date/time object.
To calculate a difference between time zones, use the GetTimeZoneInfo function.
<h3>LSDateFormat Example</h3> <p>LSDateFormat formats the date part of a date/time value using the locale convention. <!--- loop through a list of locales; show date values for Now()---> <cfloop list = "#Server.Coldfusion.SupportedLocales#" index = "locale" delimiters = ","> <cfset oldlocale = SetLocale(locale)> <cfoutput><p><B><I>#locale#</I></B><br> #LSDateFormat(Now(), "mmm-dd-yyyy")#<br> #LSDateFormat(Now(), "mmmm d, yyyy")#<br> #LSDateFormat(Now(), "mm/dd/yyyy")#<br> #LSDateFormat(Now(), "d-mmm-yyyy")#<br> #LSDateFormat(Now(), "ddd, mmmm dd, yyyy")#<br> #LSDateFormat(Now(), "d/m/yy")#<br> #LSDateFormat(Now())#<br> <hr noshade> </cfoutput> </cfloop>