View comments | RSS feed

DateFormat

Description

Formats a date value using U.S. date formats. For international date support, use LSDateFormat.

Returns

A text string representing the date formatted according to the mask. If no mask is specified, returns the value in dd-mmm-yy format.

Category

Date and time functions

Function syntax

DateFormat("date" [, "mask" ])

See also

Now, CreateDate, LSDateFormat, LSParseDateTime, LSTimeFormat, TimeFormat, ParseDateTime

History

ColdFusion MX: Added support for the following mask parameter options: short, medium, long, and full.

Parameters

Parameter Description

date

Date/time object, in the range 100 AD-9999 AD.

mask

Characters that show how ColdFusion displays a date:

  • d: Day of the month as digits; no leading zero for single-digit days.
  • dd: Day of the month as digits; leading zero for single-digit days.
  • ddd: Day of the week as a three-letter abbreviation.
  • dddd: Day of the week as its full name.
  • m: Month as digits; no leading zero for single-digit months.
  • mm: Month as digits; leading zero for single-digit months.
  • mmm: Month as a three-letter abbreviation.
  • mmmm: Month as its full name.
  • yy: Year as last two digits; leading zero for years less than 10.
  • yyyy: Year represented by four digits.
  • gg: Period/era string. Ignored. Reserved.
    The following masks tell how to format the full date and cannot be combined with other masks:
  • short: equivalent to m/d/y
  • medium: equivalent to mmm d, yyyy
  • long: equivalent to mmmm d, yyyy
  • full: equivalent to dddd, mmmm d, yyyy

Usage

When passing a date/time object as a string, you must enclose it in quotation marks. Otherwise, it is interpreted as a numeric representation of a date/time object.

Note: You can pass the CreateDate function or Now function as the date parameter of this function; for example: #DateFormat(CreateDate(2001, 3, 3))#

Date and time values in database query results can vary in sequence and formatting unless you use functions to format them. To ensure that application users correctly understand displayed dates and times, Macromedia recommends that you use this function and the LSDateFormat, TimeFormat, and LSTimeFormat functions to format resultset values. For more information and examples, see TechNote 22183, "ColdFusion Server (5 and 4.5.x) with Oracle: Formatting Date and Time Query Results," on the Macromedia website at www.coldfusion.com/Support/KnowledgeBase/SearchForm.cfm.

Note: The DateFormat function is best used for formatting output, not for formatting input. For formatting input, use one of the date/time creation functions (for example, CreateDate) instead.

Example

<cfset todayDate = Now()>
<body>
<h3>DateFormat Example</h3>
<p>Today's date is <cfoutput>#todayDate#</cfoutput>.
<p>Using DateFormat, we can display that date in different ways:
<cfoutput>
<ul>
   <li>#DateFormat(todayDate)#
   <li>#DateFormat(todayDate, "mmm-dd-yyyy")#
   <li>#DateFormat(todayDate, "mmmm d, yyyy")#
   <li>#DateFormat(todayDate, "mm/dd/yyyy")#
   <li>#DateFormat(todayDate, "d-mmm-yyyy")#   
   <li>#DateFormat(todayDate, "ddd, mmmm dd, yyyy")#   
   <li>#DateFormat(todayDate, "short")#
   <li>#DateFormat(todayDate, "medium")#
   <li>#DateFormat(todayDate, "long")#
   <li>#DateFormat(todayDate, "full")#
</ul>
</cfoutput>

ColdFusion MX 7 | ColdFusion MX 6.1 | ColdFusion MX | ColdFusion 5 | Forums | Developer Center | KnowledgeBase | Bug Reporting

Version 7

Comments


john85 said on Sep 14, 2007 at 7:35 AM :
shouldn't

<cfoutput>#DateFormat('13/12/2007','mm/dd/yyyy')#</cfoutput>

Failed since month is 13??? Instead of returning 12/13/2007???

fail here: <cfoutput>#DateFormat('13/13/2007','mm/dd/yyyy')#</cfoutput>
halL said on Sep 17, 2007 at 8:21 AM :
In response to John85: When ColdFusion converts a string into a date it tries hard to interpret it as a date.
Because 13/12/2007 is a valid date in dd/mm/yyyy format, it accepts it as Dec. 13.

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/7/htmldocs/00000441.htm