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:nn tt format. For international time formatting, see LSTimeFormat.
Category
Date and time functions, Display and formatting functions
Function syntax
TimeFormat(time [, mask ])
See also
CreateTime, Now, ParseDateTime, LSTimeFormat, DateFormat
History
ColdFusion 10: The mask "m or M" for minute is deprecated. Recommended "n or N".
ColdFusion MX 6.1: Added the mask character L or l to represent milliseconds.
ColdFusion MX:
- Changed the way extra characters are processed: this function processes extra characters within the maskvalue differently than in earlier releases, as follows:
- ColdFusion 5 and earlier: the function returns the time format and an apostrophe-delimited list of the extra characters. For example, TimeFormat(Now(), "hh:mm:ss dog") returns 8:17:23 d'o'g .
- ColdFusion MX: the function returns the time format and the extra characters. For example, for the call above, it returns 8:17:23 dog.
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.
- Added support for the following mask parameter options: short, medium, long, and full.
Parameters
Parameter |
Description |
|---|---|
time |
A date/time value or string to convert |
mask |
Masking characters that determine the format:
|
Usage
When passing a date/time value as a string, 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, Adobe recommends that you use the DateFormat and TimeFormat functions to format date and time values from queries.
Example
<cfscript>
todaydate = Now();
writeOutput(TimeFormat(todaydate));
</cfscript>
Output
07:24 AM
Example of using masks z, Z, X, XX, and XXX
<cfscript>
writeoutput(timeFormat(now(), "hh:mm:ss, z"));
writeoutput(timeFormat(now(), "hh:mm:ss, Z"));
writeoutput(timeFormat(now(), "hh:mm:ss, X"));
writeoutput(timeFormat(now(), "hh:mm:ss, XX"));
writeoutput(timeFormat(now(), "hh:mm:ss, XXX"));
</cfscript>
Output
07:26:56, UTC
07:26:56, +0000
07:26:56, Z
07:26:56, Z
07:26:56, Z
Example of using masks k and K
<cfscript>
myDateTime = now();
WriteOutput(timeFormat(myDateTime,"hh:mm:ss,k" & "<br/>"));
WriteOutput(timeFormat(myDateTime,"hh:mm:ss,K" & "<br/>"));
</cfscript>
Output
07:28:27,7
07:28:27,7