| TIMEFORMAT | |
| Description
Formats a time value using U.S. English time formatting conventions. |
|
| Returns
A custom-formatted time value. If no mask is specified, returns a time value using the hh:mm tt format. For international time formatting, see LSTimeFormat. |
|
| Category
Date and time functions, Display and formatting functions |
|
Function syntaxTimeFormat(time [, mask ]) |
|
| See also
CreateTime, Now, ParseDateTime, LSTimeFormat, DateFormat |
|
| History
ColdFusion MX 6.1: Added the mask character L or l to represent milliseconds. ColdFusion MX:
If the extra characters are single-quoted (for example, hh:mm:ss 'dog'), ColdFusion 5 and ColdFusion MX return the time format and the extra characters: 8:17:23 dog. |
|
| Parameters
|
|
| Usage
When passing a date/time value as a string, you must enclose it in quotation marks. Otherwise, it is interpreted as a number representation of a date/time object. Database query results for date and time values can vary in sequence and formatting unless you use functions to format the results. To ensure that dates and times display with appropriate formatting, and that users of your ColdFusion application are not confused by dates and times displayed, Macromedia recommends that you use the DateFormat and TimeFormat functions to format date and time values from queries. For more information and examples, see TechNote 22183, "ColdFusion Server (5 and 4.5.x) with Oracle: Formatting Date and Time Query Results," at www.coldfusion.com/Support/KnowledgeBase/SearchForm.cfm. |
|
Example<cfset todayDate = #Now()#> <body> <h3>TimeFormat Example</h3> <p>Today's date is <cfoutput>#todayDate#</cfoutput>. <p>Using Timeformat, we can display the value in different ways: <cfoutput> <ul> <li>#TimeFormat(todayDate)# <li>#TimeFormat(todayDate, "hh:mm:ss")# <li>#TimeFormat(todayDate, "hh:mm:sst")# <li>#TimeFormat(todayDate, "hh:mm:sstt")# <li>#TimeFormat(todayDate, "HH:mm:ss")# </ul> </cfoutput> <p>To generate a standard ISO 8601 W3C Date and Time string like 1997-07-16T19:20, concatenate a DateFormat function, the character T, and a TimeFormat function. For example: dateformat(now(), "yyyy-mm-dd")#T#TimeFormat(now(), "HH:mm:ss") produces:</p> <cfoutput>#dateformat(now(), "yyyy-mm-dd")#T#TimeFormat(now(), "HH:mm:ss")#</ cfoutput> </body> |
|