StringToDays (String function)

From m204wiki
Revision as of 20:08, 6 February 2012 by Dme (talk | contribs) (→‎Usage notes)
Jump to navigation Jump to search

Convert string date/time to days since 1900 (String class)

[Introduced in Sirius Mods 7.8]


StringToDays is an intrinsic function to convert a date/time string to days since 1900.

Syntax

%days = string:StringToDays( format, [[CentSpan=] number]) Throws InvalidDateString

Syntax terms

%days The float variable to receive the computed time since 1900.
string The input date/time string, which must be in the format specified by format.
format The format of the date/time string. See "Datetime Formats".
CentSpan The CENTSPAN value used, if the format has a two-digit year. The default is specified by the CENTSPAN_parameter. In Sirius Mods 7.9 and later this is a NameAllowed parameter. For versions prior to 7.9, it is a positional parameter.

Usage notes

  • If the format is invalid, the request is cancelled.
  • If the date contents of the method object string is invalid, an InvalidDateString exception is thrown.

Examples

See also