lSDateFormat

Description

Formats the date part of a date/time value in a locale-specific format.

History

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. Added support for the following mask parameter options: short, medium, long, and full.

Syntax

LSDateFormat(date [, mask, locale])

Attributes

Attribute	Description	Required	Default
date	A date/time object, in the range 100 AD–9999 AD.
locale	Locale to use instead of the locale of the page when processing the function
mask	Characters that show how ColdFusion displays the date: d: Day of month. Digits; no leading zero for single-digit days dd: Day of month. Digits; leading zero for single-digit days ddd: Day of week, abbreviation dddd: Day of week. Full name m: Month. Digits; no leading zero for single-digit months mm: Month. Digits; leading zero for single-digit months mmm: Month. abbreviation (if appropriate) mmmm: Month. Full name y: Year. Last two digits; no leading zero for years less than 10 yy: Year. Last two digits; leading zero for years less than 10 yyyy: Year. Four digits gg: Period/era string. Not processed. Reserved for future use The following conform to Java locale-specific time encoding standards. Their exact formats depend on the locale: short: dd, mm, and yy separated by / marks medium: text format using mmm, d, and yyyy long: text format using mmmm, d, and yyyy full: text format using dddd, mmmm, d, and yyyy The default value is medium For more information on formats, see LSParseDateTime.

Returns

A formatted date/time value. If no mask is specified, the value is formatted according to the locale setting of the client computer.

Usage

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.

Example

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

cfmldocs