LSDateFormat

Description

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

Return value

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

Syntax

LSDateFormat(date [, mask ])

History

New in ColdFusion MX:

This function might return different formatting than in earlier releases. This function uses Java standard locale formatting rules on all platforms.
This function supports the short, medium, long, and full mask attribute options.

Parameters

Parameter Description

date
A date/time object, in the range 100 AD-9999 AD. See "How ColdFusion processes two-digit year values".

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. Three-letter 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. Three-letter abbreviation

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

short

medium

long

full

Default: the Java standard Medium format for the locale.
For more information on formats, see "LSParseDateTime".

Parameter	Description
date	A date/time object, in the range 100 AD-9999 AD. See "How ColdFusion processes two-digit year values".
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. Three-letter 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. Three-letter abbreviation 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 short medium long full Default: the Java standard Medium format for the locale. For more information on formats, see "LSParseDateTime".

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.

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

Example

<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>