Formats a datetime using a given locale.

Text = SRP_DateTime("Format", Datetime, Format = "Short", Locale = "")


Formatted text.


DatetimeA datetime in OI internal format. (REQUIRED)
FormatA custom or predefined format. (OPTIONAL)
LocaleA locale for culture specific formatting. (OPTIONAL)


The "Format" service converts an OI datetime into human readable text, much like OConv. Unlike OConv, however, this service supports infinite formatting options and localization.

Auto Format

You can set Format to either "Short" or "Long". In either case, the Locale will determine the format. Here are some examples, all formatting the datetime January 14, 2020 at 3:07:43pm:

LocaleShort FormatLong Format
en-US1/14/2020 3:07 PMTuesday, January 14, 2020 3:07:43 PM
es-ES14/01/2020 15:07martes, 14 de enero de 2020 15:07:43
fr-FR14/01/2020 15:07mardi 14 janvier 2020 15:07:43

If you omit Format or set it to "", then "Short" will be used.

Custom Format

You can customize the format using a special syntax. You can use any characters in the Format, but 'Y', 'y', 'M', 'm', 'D', 'd', 'H', 'h', 'S', 's', 'A', 'a', 'T', and 't' are reserved characters. Any other character is treated as a literal and is displayed as is. Thus, you may use literal characters in your format to prefix or suffix the date as you choose. If you need to use any reserved characters literally, then surround your literal text in single or double quotes. If you need to display quotes, place two of them side by side. The reserved characters are interpreted as follows:

Character(s)DisplaysExample using 1/14/2020 3:07:43pmExample using es-ES
YY2-digit year2020
MM2-digit Month0101
MMMAbbreviated month nameJanene.
MMMMMonth nameJanuaryenero
MMMMMMonth initialJe
DD2-digit day1414
DDDAbbreviate day of the week nameTuema.
DDDDDay of the weekTuesdaymartes
DDDDDShortest day of the week nameTuM
hh2-digit hour1515
mm2-digit minute0707
ss2-digit second4343
tAbbreviated cultural am/pmpp
ttCultural am/pmPMp

As you can see in the table above, the Locale still affects the output, but only when your format requires it.

Here are some example datetime formats, all them for the date January 14, 2020 at 3:07:43pm:


MMMM D, YYYY, h:mm aaaJanuary 14, 2020, 3:17 p.m.
enero 14, 2020, 3:17 p.m.janvier 14, 2020, 3:17 p.m.
DDDD, MMM DD, YYYY 'at' h:mm:ssttTuesday, Jan 14, 2020 at 3:17:43PM
martes, ene. 14, 2020 at 3:17:43pmardi, janv. 14, 2020 at 3:17:43PM
YYYY-MM-DD hh:mm:ss2020-01-14 15:17:43
2020-01-14 15:17:43
2020-01-14 15:17:43

You can use uppercase or lowercase for all format codes except for months and minutes. 'M' must be used for months and 'm' must be used for minutes.


The Locale parameter specifies the specific culture used to help render the final text. Omitting Locale or setting it "" causes the "Format" service to use the user's current Windows locale setting. If, however, you want to specify your own localization, set this parameter to a locale name.


// Create an OI datetime
Datetime = SRP_DateTime("Encode", 2020, 1, 14, 3, 7, 43)

// Format a datetime using the default format and the current locale
Text = SRP_DateTime("Format", Datetime)

// Format a datetime using the long format and the current locale
Text = SRP_DateTime("Format", Datetime, "Long")

// Format a datetime using the long format and the Spanish language
Text = SRP_DateTime("Format", Datetime, "Long", "es")

// Format a datetime using a custom format and the Spanish-MEXICAN language
Text = SRP_DateTime("Format", Datetime, "MMMM D, YYYY 'at' h:mm:ss tt", "es-MX")
  • No labels