Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:1.24

Description

Description:Returns a date / time in the specified format.

Syntax

Syntax:[format, date] call fn_vbs_dateToString
Parameters:
  • format: String - Formatting information:
  • 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 option j).
    • w - Numeric representation of the day of the week: 0 (for Sunday) through 6 (for Saturday).
    • z - The day of the year: 0 through 365.
  • Month:
    • F - A full textual representation of a month, such as January or March.
    • 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 - Indicates a leap year: 1 if it is a leap year, 0 otherwise.
    • Y - A full numeric representation of a year, 4 digits.
    • y - A two digit representation of a year. For example, 99 or 03.
  • Time:
    • a - Lowercase Ante meridiem and Post meridiem: am or pm.
    • A - Uppercase Ante meridiem and Post meridiem: AM or PM.
    • 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 - Milliseconds.
  • date: Array - Date array to use (optional, default: systemTime).
Return Value:String - Date / time in the specified format.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
_datestr = ["G:i:s"] call fn_vbs_dateToString; // Returns "23:45:06"
_datestr = ["jS \of F Y, \a\t h:i:s A"] call fn_vbs_dateToString; // Returns "8th of August 2005 03:12:46 PM"

Additional Information

See also: systemTime, fn vbs timeToString, fn vbs formatSeconds
Multiplayer:
Problems:

Notes