string.parseDateTime()

Parses a date/time string according to the English (U.S.) locale conventions.

To format a date/time string for other locales, use the LSParseDateTime function.

string.parseDateTime( date [, format [, timezone ] ] )

Returns: DateTime

Argument Description
date
object, required

A string containing a date/time value formatted according to U.S. locale conventions.

format
string, optional

The format (Java Syntax) of the string. This string is used to parse the given date string to date time object.

For details see: http://docs.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html

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