StringToDays (String function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (→Syntax terms) |
||
Line 12: | Line 12: | ||
<td>The input date/time string, which must be in the format specified by <var class="term">format</var>.</td></tr> | <td>The input date/time string, which must be in the format specified by <var class="term">format</var>.</td></tr> | ||
<tr><th>format</th> | <tr><th>format</th> | ||
<td>The format of the date/time string. See [[Datetime string formats#Datetime Formats|"Datetime | <td>The format of the date/time string. See [[Datetime string formats#Datetime Formats|"Datetime formats"]].</td></tr> | ||
<tr><th><var>CentSpan</var></th> | <tr><th><var>CentSpan</var></th> | ||
<td>The [[Datetime string formats#CENTSPAN|CENTSPAN]] value used, if the <var class="term">format</var> has a two-digit year. The default is specified by the [[CENTSPAN parameter]]. In <var class="product">Sirius Mods</var> 7.9 and later this is a <var>[[Notation conventions for methods#Named parameters|NameAllowed]]</var> parameter. For versions prior to 7.9, it is a positional parameter.</td/tr> | <td>The [[Datetime string formats#CENTSPAN|CENTSPAN]] value used, if the <var class="term">format</var> has a two-digit year. The default is specified by the [[CENTSPAN parameter]]. In <var class="product">Sirius Mods</var> 7.9 and later this is a <var>[[Notation conventions for methods#Named parameters|NameAllowed]]</var> parameter. For versions prior to 7.9, it is a positional parameter.</td/tr> |
Revision as of 21:54, 7 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 value is invalid, the request is canceled.
- Values returned by StringToDays can be stored in a BINARY or FLOAT4 field, if you want.
- Dates prior to 1 January 1900 return a negative number.
- The inverse of this function is DaysToString.