  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Five — General Functions (continued)
Overview
The FormatDate function converts a date-time qword to a formatted string.
Syntax/Parameters
Syntax
string = FormatDate ( qword | string value, [int format | string format] );
Parameters
value
A qword containing a date-time value in milliseconds. The value is expected to be UTC based, or,
A string in ISO-8601 format.
format
An optional int containing bitwise flags for a date formatting. See the date string (DS_) format codes at the start of this section. The default value for this function is DS_ISO_8601. By default, the value is converted to local time before formatting to a string. Using the DS_FILETIME_UTC flag will stop the conversion to local time. See the date string (DS_) format codes in Section 5.12 Date and Time Functions for more information. Or,
An option string specifying a format similar to PHP. See Remarks.
Return Value
Returns a string containing the date-time value formatted as specified by format or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
The FormatDate function can be used in conjunction with other functions, set as the GetFileCreateTime function, to convert a numeric representation of a date as a number of milliseconds to a string. The function assumes the millisecond count begins on January 1, 1601 (UTC) and by default the date-time value is converted to local time.
If the source value parameter is a string, it is time zone independent.
The format string can use the following substitution characters (based on PHP 5.x):
| Character | Description | Example returned values | ||||
| Day | ||||||
| d | Day of the month, 2 digits with leading zeros. | 01 to 31 | ||||
| D | A textual representation of a day, three letters. | Mon through Sun | ||||
| j | Day of the month without leading zeros. | 1 to 31 | ||||
| l | A full textual representation of the day of the week. | Sunday through Saturday | ||||
| N | ISO-8601 numeric representation of the day of the week. | 1 (for Monday) through 7 (for Sunday) | ||||
| S | English ordinal suffix for the day of the month, 2 characters. | st, nd, rd or th. Works well with j | ||||
| w | Numeric representation of the day of the week. | 0 (for Sunday) through 6 (for Saturday) | ||||
| z | The day of the year (starting from 0) | 0 through 365 | ||||
| Week | ||||||
| W | ISO-8601 week number of year, weeks starting on Monday (not supported). | Example: 42 (the 42nd week in the year) | ||||
| Month | ||||||
| F | A full textual representation of a month, such as January or March. | January through December | ||||
| m | Numeric representation of a month, with leading zeros. | 01 through 12 | ||||
| M | A short textual representation of a month, three letters. | Jan through Dec | ||||
| n | Numeric representation of a month, without leading zeros. | 1 through 12 | ||||
| t | Number of days in the given month. | 28 through 31 | ||||
| Year | ||||||
| L | Whether it is a leap year. | 1 if it is a leap year, 0 otherwise. | ||||
| o | ISO-8601 year number. This has the same value as Y (PHP supports the exception that if the ISO week number (W) belongs to the previous or next year, that year is used instead. Legato does not.) | Examples: 1999 or 2003 | ||||
| Y | A full numeric representation of a year, 4 digits. | Examples: 1999 or 2003 | ||||
| y | A two digit representation of a year. | Examples: 99 or 03 | ||||
| Time | ||||||
| a | Lowercase Ante meridiem and Post meridiem. | am or pm | ||||
| A | Uppercase Ante meridiem and Post meridiem. | AM or PM | ||||
| B | Swatch Internet time. | 000 through 999 | ||||
| g | 12-hour format of an hour without leading zeros. | 1 through 12 | ||||
| G | 24-hour format of an hour without leading zeros. | 0 through 23 | ||||
| h | 12-hour format of an hour with leading zeros. | 01 through 12 | ||||
| H | 24-hour format of an hour with leading zeros. | 00 through 23 | ||||
| i | Minutes with leading zeros. | 00 to 59 | ||||
| s | Seconds, with leading zeros. | 00 through 59 | ||||
| u | Microseconds. | Example: 654321 | ||||
| Timezone | ||||||
| e | Time zone identifier (not supported). | Examples: UTC, GMT ... | ||||
| I | Whether or not the local system is in daylight saving time. | 1 if Daylight Saving Time, 0 otherwise. | ||||
| O | Difference to Greenwich time (GMT) in hours. | Example: +0200 | ||||
| P | Difference to Greenwich time (GMT) with colon between hours and minutes. | Example: +02:00 | ||||
| T | Time zone abbreviation (not supported). | Examples: EST, MDT ... | ||||
| Z | Time zone offset in seconds. The offset for time zones west of UTC is always negative, and for those east of UTC is always positive. | -43200 through 50400 | ||||
| Full Date/Time | ||||||
| c | ISO 8601 date (not supported). | 2004-02-12T15:19:21+00:00 | ||||
| r | RFC 2822 formatted date (not supported). | Example: Thu, 21 Dec 2000 16:01:07 +0200 | ||||
| U | Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT) (not supported). | — | ||||
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.