# LSDateTimeFormat

Formats a date in a locale-specific format

## Method Signature

```
LSDateTimeFormat(date=[any], mask=[string], locale=[string], timezone=[string])
```

### Arguments

| Argument   | Type     | Required | Description                                                                           | Default |
| ---------- | -------- | -------- | ------------------------------------------------------------------------------------- | ------- |
| `date`     | `any`    | `true`   | The date string or object                                                             |         |
| `mask`     | `string` | `false`  | Optional format mask, or common mask                                                  |         |
| `locale`   | `string` | `false`  | Optional locale designation of the output ( e.g. es-SA )                              |         |
| `timezone` | `string` | `false`  | Optional specific timezone to apply to the date ( if not present in the date string ) |         |

## Examples

## Related

* [createDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/createdate)
* [DateCompare](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/datecompare)
* [DateFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dateformat)
* [DateTimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/datetimeformat)
* [DayOfWeekAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dayofweekasstring)
* [DayOfWeekShortAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/dayofweekshortasstring)
* [GetHTTPTimestring](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/broken-reference)
* [LSDateFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsdateformat)
* [LSDayOfWeek](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsdayofweek)
* [LSIsDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsisdate)
* [LSParseDateTime](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsparsedatetime)
* [LSTimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lstimeformat)
* [LSWeek](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/lsweek)
* [MonthAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/monthasstring)
* [MonthShortAsString](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/monthshortasstring)
* [ParseDateTime](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/parsedatetime)
* [TimeFormat](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/timeformat)
* [ToLegacyDate](https://boxlang.ortusbooks.com/boxlang-framework/modularity/compat-cfml/reference/built-in-functions/temporal/tolegacydate)