[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'sysutils' (#rtl)

# FormatDateTime

Return a string representation of a TDateTime value with a given format.

## Declaration

Source position: datih.inc line 157

`function FormatDateTime(`
`const FormatStr: string;`
`DateTime: TDateTime;`
`Options: TFormatDateTimeOptions = []`
`):string; function FormatDateTime(`
`const FormatStr: string;`
`DateTime: TDateTime;`
`const FormatSettings: TFormatSettings;`
`Options: TFormatDateTimeOptions = []`
`):string;`

## Description

FormatDateTime formats the date and time encoded in DateTime according to the formatting given in FormatStr. The complete list of formatting characters can be found in formatchars.

When the format string is empty, 'c' is used instead.

Note that on unix systems, the localization support must be enabled explicitly, see Localization.

## Errors

On error (such as an invalid character in the formatting string), and EConvertError exception is raised.

## See also

DateTimeToStr |  | Converts a TDateTime value to a string using a predefined format.
DateToStr |  | Converts a TDateTime value to a date string with a predefined format.
TimeToStr |  | Convert a TDateTime time to a string using a predefined format.
StrToDateTime |  | Convert a date/time string to a TDateTime value.
EConvertError |  | Conversion error.
Localization |  | Localization support

## Example

    Program Example14;

    { This program demonstrates the FormatDateTime function }

    Uses sysutils;

    Var ThisMoment : TDateTime;

    Begin
      ThisMoment:=Now;
      Writeln ('Now : ',FormatDateTime('hh:nn',ThisMoment));
      Writeln ('Now : ',FormatDateTime('DD MM YYYY',ThisMoment));
      Writeln ('Now : ',FormatDateTime('c',ThisMoment));
    End.