LSTimeFormat

Description

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

Syntax


LSTimeFormat(time [, mask ])

Parameters

Parameter

Description

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

mask
Masking characters that determine the format:

h    Hours; no leading zero for single-digit hours (12-hour clock)

hh    Hours with a 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; a leading zero for single-digit minutes

s    Seconds; no leading zero for single-digit seconds

ss    Seconds; 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

Parameter	Description
string	A date/time value or string convertible to a time value.
mask	Masking characters that determine the format: `h` Hours; no leading zero for single-digit hours (12-hour clock) `hh` Hours with a 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; a leading zero for single-digit minutes `s` Seconds; no leading zero for single-digit seconds `ss` Seconds; 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, enclose it in quotes. Otherwise, it is interpreted as a number representation of a date/time object.

Example

<!--- 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 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>