User Guide

LSTimeFormat 621
LSTimeFormat
Description
Formats the time part of a date/time string into a string in a locale-specific format.
Returns
A string representing the time value.
Category
Date and time functions, Display and formatting functions, International functions
Function syntax
LSTimeFormat(time [, mask ])
See also
LSParseDateTime, LSDateFormat, TimeFormat
History
ColdFusion MX 6.1: Added the mask character L or l to represent milliseconds.
ColdFusion MX:
• Changed formatting behavior: this function might return different formatting than in earlier
releases. This function uses Java standard locale formatting rules on all platforms.
• Added support for the following mask attribute options: short, medium, long, and full.
Parameters
Parameter Description
string • A date/time value
• A string that is convertible to a time value
A date/time object is in the range 100 AD–9999 AD.
mask Masking characters that determine the format:
• h: Hours; no leading zero for single-digit hours (12-hour clock)
• hh: Hours; leading zero for single-digit hours. (12-hour clock)
• H: Hours; no leading zero for single-digit hours (24-hour clock)
• HH: Hours; leading zero for single-digit hours (24-hour clock)
• m: Minutes; no leading zero for single-digit minutes
• mm: Minutes; leading zero for single-digit minutes
• s: Seconds; no leading zero for single-digit seconds
• ss: Seconds; leading zero for single-digit seconds
• l: Milliseconds
• t: One-character time marker string, such as A or P.
• tt: Multiple-character time marker string, such as AM or PM
The following conform to Java locale-specific time encoding standards. Their exact
formats depend on the locale:
• short: includes hours, minutes; may include AM or PM
• medium: includes hours, minutes; may include AM or PM
• long: medium plus time zone
• full: long, may also include an hour designator
Default: short