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; "Locales" in Chapter 17, "Developing Globalized Applications" in ColdFusion MX Developer's Guide

 
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 parameter options: short, medium, long, and full.
 
Parameters

 
Usage

This function uses Java standard locale formatting rules on all platforms.

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

To calculate a difference between time zones, use the GetTimeZoneInfo function.

To set the default display format of date, time, number, and currency values, use the SetLocale function.

If no seconds value is passed to this function, and the mask value is s, the default output seconds format is one zero; for example, lstimeformat(6:39, "h:m:s") returns 6:39:0. If the mask value is ss, it returns 6:39:00.

 
Example
<h3>LSTimeFormat Example</h3>

<p>LSTimeFormat returns a time value using the locale convention. 

<!--- loop through a list of locales and show time values --->
<cfloop LIST = "#Server.Coldfusion.SupportedLocales#"
index = "locale" delimiters = ",">
   <cfset oldlocale = SetLocale(locale)>

   <cfoutput><p><B><I>#locale#</I></B><br>
   #LSTimeFormat(Now())#<br>
   #LSTimeFormat(Now(), `hh:mm:ss')#<br>   
   #LSTimeFormat(Now(), `hh:mm:sst')#<br>   
   #LSTimeFormat(Now(), `hh:mm:sstt')#<br>   
   #LSTimeFormat(Now(), `HH:mm:ss')#<br>   
      <hr noshade>
   </cfoutput>

</cfloop>

A date/time object is in the range 100 AD-9999 AD.

STRING  

Masking characters that determine the format:

The following conform to Java locale-specific time encoding standards. Their exact formats depend on the locale:

The default value is short.

MASK