timeFormat

Formats a time value using US English time formatting conventions. If no mask is specified, returns a time value using the hh:mm tt format. For international time formatting, see LSTimeFormat.

timeFormat(time [, mask]) → returns string

Member Function Syntax

time.timeFormat([mask])

  1. CFDocs
  2. Functions
  3. Date and Time Functions
  4. timeFormat
  5. CF
  6. Lucee
  7. BL 1.0.0+
  8. 0 Issue
  9. Edit
See Also:   lsTimeFormat   dateFormat

Argument Reference

time date
Required

A date/time value or string to convert

mask string
Default: hh:mm tt

Masking characters that determine the format.
h,hh: Hours in 12 hour format
,H,HH: Hours in 24 hour format
m,mm: Minutes
s,ss: Seconds
l: Milliseconds
t: A or P
tt: AM or PM
z: Time zone in literal format, for example GMT
Z: Time zone in hours offset (RFC822), for example +0400
X,XX,XXX: Time zone in hours of offset in ISO 8601 format
"short": h:mm tt
"medium": h:mm:ss tt
Values:
  • short
  • medium
  • long
  • full

Compatibility

ColdFusion:

Member function is available in CF11+. The z Z and X masks were added in CF2016+

Lucee:

Member function is available in Lucee5+.

Examples
Sample code invoking the timeFormat function 

timeFormat( createDateTime(2017, 8, 31, 15, 25, 11), "h:mm tt")

Expected Result: 3:25 PM

Requires CF 11+ or Lucee 5+

createDateTime(2017, 8, 31, 15, 25, 11).timeFormat("h:mm tt")

Expected Result: 3:25 PM

Should default mask to hh:mm tt

timeFormat( createDateTime(2017, 8, 31, 15, 25, 11) )

Expected Result: 03:25 PM

Signup for cfbreak to stay updated on the latest news from the ColdFusion / CFML community. One email, every friday.

Fork me on GitHub