toDateTime
Table of Contents
Overview
The toDateTime function takes an expression as an argument, and returns the expression (containing a date-time value) in the date format as specified in application settings.
This function takes an optional argument dateTimeMapping when the given expression is of text data type. It is used to denote the date-time components for which the values in the text stand for.
Return Type
- DATE-TIME
Syntax
<variable> = <expression>.toDateTime(<dateTimeMapping>);
where,
| Parameter | Data type | Description |
| <variable> | DATE-TIME | Variable which will contain the returned date value. |
| <expression> | TEXT/NUMBER/DATE-TIME | The expression (containing a valid date time format) which will be returned in date format. When the data type is NUMBER:
When the data type is Date-Time, the additional parameters (mentioned below) are ignored. And, the function will throw a runtime error if the month value exceeds the number of months in a year, or the day value exceeds the number of days in a month. |
<dateTimeMapping> (optional) | DATE-TIME | The format in which the date-time value must be represented. Applies when the given expression is of Text data type. You can specify date-time literals (as mentioned in the below table) to denote the date value components in the expression as required. The pattern letters must be separated using the exact same separator as given in the expression. When the month is specified as numerical value, the month pattern letter "M" must be specified as M or MM. When the month is specified as a text value, the month pattern letter "M" must be specified as MMM (or may contain more number of M's). |
Applicable Date-Time literals:
| Literal | Date and Time component |
|---|---|
| y | Year |
| M | Month in year |
| d | Day in month |
| a | am/pm marker |
| H | Hour in day (0-23) |
| h | Hour in am/pm (1-12) |
| m | Minute in hour |
| s | Second in minute |
Examples
currentTime="01-11-2019 13:30:00"; //Assuming, date time format set in application settings is dd-MMM-yyyy. formatted_date = toDateTime(currentTime,"MM-d-yy"); // formatted_date is assigned the value '11-Jan-2019 13:30:00'