StringToDays (String function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (→Usage notes) |
||
Line 21: | Line 21: | ||
<li>If the <var class="term">format</var> is invalid, the request is cancelled. | <li>If the <var class="term">format</var> is invalid, the request is cancelled. | ||
<li>If the date contents of the method object <var class="term">string</var> is invalid, an <var>[[InvalidDateString]]</var> exception is thrown. | <li>If the date contents of the method object <var class="term">string</var> is invalid, an <var>[[InvalidDateString]]</var> exception is thrown. | ||
<li>If the <var>CentSpan</var> is invalid, the request is cancelled. | |||
<li>Values returned by <var>StringToDays</var> can be stored in a BINARY or FLOAT4 field, if you wish. | |||
<li>Dates prior to 1 January 1900 will return a negative number. | |||
<li>The inverse of this $function is <var>[[DaysToString (Float function)|DaysToString]]</var>. | |||
</ul> | </ul> | ||
Revision as of 20:16, 6 February 2012
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.
- If the CentSpan is invalid, the request is cancelled.
- Values returned by StringToDays can be stored in a BINARY or FLOAT4 field, if you wish.
- Dates prior to 1 January 1900 will return a negative number.
- The inverse of this $function is DaysToString.