Show: Delphi C++
Display Preferences

System.SysUtils.DateTimeToString

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DateTimeToString(var Result: string; const Format: string; DateTime: TDateTime);
procedure DateTimeToString(var Result: string; const Format: string; DateTime: TDateTime; const AFormatSettings: TFormatSettings);

C++

extern DELPHI_PACKAGE void __fastcall DateTimeToString(System::UnicodeString &Result, const System::UnicodeString Format, System::TDateTime DateTime)/* overload */;

Properties

Type Visibility Source Unit Parent
procedure
function
public
System.SysUtils.pas
System.SysUtils.hpp
System.SysUtils System.SysUtils

Description

Converts a TDateTime value into a string, using a specified Format.

DateTimeToString converts the TDateTime value given by DateTime using the format string given by Format into the string variable given by Result. See the table below for information about the supported format strings.

The first form of DateTimeToString is not thread-safe, because it uses localization information contained in global variables. The second form of DateTimeToString, which is thread-safe, refers to localization information contained in the AFormatSettings parameter. Before calling the thread-safe form of DateTimeToString, you must populate AFormatSettings with localization information. To populate AFormatSettings with a set of default locale values, call TFormatSettings.Create.

Date Time Format strings are composed from specifiers that represent values to be inserted into the formatted string. Some specifiers (such as "d") simply format numbers or strings. Other specifiers (such as "/") refer to locale-specific strings from global variables.

In the following table, specifiers are given in lowercase. Case is ignored in formats, except for the "am/pm" and "a/p" specifiers.


Specifier Displays

c

Displays the date using the format given by the ShortDateFormat global variable, followed by the time, using the format given by the LongTimeFormat global variable. The time is not displayed if the date-time value indicates midnight precisely.

d

Displays the day as a number without a leading zero (1-31).

dd

Displays the day as a number with a leading zero (01-31).

ddd

Displays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable.

dddd

Displays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable.

ddddd

Displays the date using the format given by the ShortDateFormat global variable.

dddddd

Displays the date using the format given by the LongDateFormat global variable.

e

(Windows only) Displays the year in the current period/era as a number without a leading zero (Japanese, Korean, and Taiwanese locales only).

ee

(Windows only) Displays the year in the current period/era as a number with a leading zero (Japanese, Korean, and Taiwanese locales only).

g

(Windows only) Displays the period/era as an abbreviation (Japanese and Taiwanese locales only).

gg

(Windows only) Displays the period/era as a full name (Japanese and Taiwanese locales only).

m

Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.

mm

Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.

mmm

Displays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable.

mmmm

Displays the month as a full name (January-December) using the strings given by the LongMonthNames global variable.

yy

Displays the year as a two-digit number (00-99).

yyyy

Displays the year as a four-digit number (0000-9999).

h

Displays the hour without a leading zero (0-23).

hh

Displays the hour with a leading zero (00-23).

n

Displays the minute without a leading zero (0-59).

nn

Displays the minute with a leading zero (00-59).

s

Displays the second without a leading zero (0-59).

ss

Displays the second with a leading zero (00-59).

z

Displays the millisecond without a leading zero (0-999).

zzz

Displays the millisecond with a leading zero (000-999).

t

Displays the time using the format given by the ShortTimeFormat global variable.

tt

Displays the time using the format given by the LongTimeFormat global variable.

am/pm

Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.

a/p

Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.

ampm

Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the TimeAMString global variable for any hour before noon, and the contents of the TimePMString global variable for any hour after noon.

/

Displays the date separator character given by the DateSeparator global variable.

:

Displays the time separator character given by the TimeSeparator global variable.

'xx'/"xx"

Characters enclosed in single or double quotation marks are displayed as such, and do not affect formatting.


See Also

Personal tools
In Other Languages
Previous Versions
Assistance