datetime.lSDateFormat()

Formats a date string to a given output using the current sessions locale

datetime.lSDateFormat( date [, mask [, locale [, timezone ] ] ] )

Returns: String

Argument Description
date
any, required

date object

mask
string, optional
locale
locale, optional

Locale to use instead of the locale of the page when processing the function

timezone
timezone, optional

A datetime object is independent of a specific timezone, it is only an offset in milliseconds from 1970-1-1 00.00:00 UTC (Coordinated Universal Time).

This means that the timezone only comes into play when you need specific information like hours in a day, minutes in a hour or which day it is since those calculations depend on the timezone.

For these calculations, a timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function setTimezone.

You can find a list of all available timezones in the Lucee administrator (Settings/Regional). Some examples of valid timezones:

  • AGT (for time in Argentina)
  • Europe/Zurich (for time in Zurich/Switzerland)
  • HST (Hawaiian Standard Time in the USA)

Examples

There are currently no examples for this function

See also