LSTimeFormat

Returns a custom-formatted time value using the locale convention.

Syntax

LSTimeFormat(time [, mask ])

string

Any date/time value or string convertible to a time value.

mask

A set of masking characters determining the format:

h -- Hours with no leading zero for single-digit hours. (Uses a 12-hour clock.)
hh -- Hours with a leading zero for single-digit hours. (Uses a 12-hour clock.)
H -- Hours with no leading zero for single-digit hours. (Uses a 24-hour clock.)
HH -- Hours with a leading zero for single-digit hours. (Uses a 24-hour clock.)
m -- Minutes with no leading zero for single-digit minutes
mm -- Minutes with a leading zero for single-digit minutes
s -- Seconds with no leading zero for single-digit seconds
ss -- Seconds with a leading zero for single-digit seconds
t -- Single-character time marker string, such as A or P. Ignored by some locales.
tt -- Multiple-character time marker string, such as AM or PM

Usage

When passing date/time value as a string, make sure it is enclosed in quotes. Otherwise, it is interpreted as a number representation of a date/time object returning undesired results.

Examples

<!--- This shows LSTimeFormat --->
<HTML>
<HEAD>
<TITLE>LSTimeFormat Example</TITLE>
</HEAD>

<BODY>
<H3>LSTimeFormat Example</H3>

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

<!--- loop through a list of possible 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>

</BODY>
</HTML>

CFML Language Reference
Chapter 2 : ColdFusion Functions