StringToMilliseconds (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "{{Template:String:StringToMilliseconds subtitle}} <var>StringToMilliseconds</var> is an <var>intrinsic</var> function to convert a [[Datetime_string_format...")
 
No edit summary
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:String:StringToMilliseconds subtitle}}
{{Template:String:StringToMilliseconds subtitle}}
 
<var>StringToMilliseconds</var> is an [[Intrinsic classes|intrinsic]] function to convert a [[Datetime_string_formats|date/time string]] to milliseconds since 1900.
<var>StringToMilliseconds</var> is an <var>[[Intrinsic classes|intrinsic]]</var> function to convert a [[Datetime_string_formats|date/time string]] to milliseconds since 1900.


==Syntax==
==Syntax==
Line 7: Line 6:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%milliseconds</th>
<tr><th nowrap>%milliseconds</th>
<td>The float variable to receive the computed time since 1900.</td></tr>
<td>The float variable to receive the computed time since 1900.</td></tr>
<tr><th>string</th>
<tr><th>string</th>
Line 13: Line 12:
<tr><th>format</th>
<tr><th>format</th>
<td>The format of the date/time string.</td></tr>
<td>The format of the date/time string.</td></tr>
<tr><th>centspan</th>
<tr><th><var>CentSpan</var></th>
<td>See [[CENTSPAN_parameter]].</td/tr>
<td>See the <var>[[CENTSPAN parameter|CENTSPAN]]</var> parameter. In <var class="product">Sirius Mods</var> 7.9 and later this is a [[Notation conventions for methods#Named parameters|name allowed]] parameter. For versions prior to 7.9, it is a positional parameter.</td/tr>
</table>
</table>
==Usage notes==


==Examples==
==Examples==
This statement uses <var>StringToMilliseconds</var> and <var>[[MillisecondsToString (Float_function)|MillisecondsToString]]</var> to convert a value in <code>YYYYMMDDHHMISSXXX</code> format to the <code>Month DAY, YYYY HH:MI:SS.XXX</code> format:
<p class="code">printText {~='20110520173648965':stringToMilliseconds('YYYYMMDDHHMISSXXX'):millisecondsToString('Month DAY, YYYY HH:MI:SS.XXX')}  </p>


The result is:
<p class="output">'20110520173648965':stringToMilliseconds('YYYYMMDDHHMISSXXX'):millisecondsToString('Month DAY, YYYY HH:MI:SS.XXX')
=May 20, 2011 17:36:48.965 </p>


==See also==
==See also==
[[StringToSeconds_(String_function)]]
<ul>
 
<li>Related intrinsic methods (provide conversion from one form of date representation to another):
[[StringToDays_(String_function)]]
<ul>
 
<li><var>[[DaysToString (Float_function)|DaysToString]]</var>
<li><var>[[MillisecondsToString (Float_function)|MillisecondsToString]]</var>
<li><var>[[SecondsToString (Float_function)|SecondsToString]]</var>
<li><var>[[StringToDays (String_function)|StringToDays]]</var>
<li><var>[[StringToSeconds (String_function)|StringToSeconds]]</var>
<li><var>[[TimeStringConvert (String_function)|TimeStringConvert]]</var>
</ul>
<li>Related <var>System</var> methods:
<ul>
<li><var>[[CurrentTimeMilliseconds (System function)|CurrentTimeMilliseconds]]</var>
<li><var>[[CurrentTimeSeconds (System function)|CurrentTimeSeconds]]</var>
<li><var>[[CurrentTimeDays (System function)|CurrentTimeDays ]]</var>
<li><var>[[CurrentTimeString (System function)|CurrentTimeString ]]</var>
</ul>
</ul>
{{Template:String:StringToMilliseconds footer}}
{{Template:String:StringToMilliseconds footer}}

Latest revision as of 22:14, 3 September 2015

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

[Introduced in Sirius Mods 7.8]

StringToMilliseconds is an intrinsic function to convert a date/time string to milliseconds since 1900.

Syntax

%milliseconds = string:StringToMilliseconds( format, [[CentSpan=] number]) Throws InvalidDateString

Syntax terms

%milliseconds The float variable to receive the computed time since 1900.
string The input date/time string.
format The format of the date/time string.
CentSpan See the CENTSPAN parameter. In Sirius Mods 7.9 and later this is a name allowed parameter. For versions prior to 7.9, it is a positional parameter.

Examples

This statement uses StringToMilliseconds and MillisecondsToString to convert a value in YYYYMMDDHHMISSXXX format to the Month DAY, YYYY HH:MI:SS.XXX format:

printText {~='20110520173648965':stringToMilliseconds('YYYYMMDDHHMISSXXX'):millisecondsToString('Month DAY, YYYY HH:MI:SS.XXX')}

The result is:

'20110520173648965':stringToMilliseconds('YYYYMMDDHHMISSXXX'):millisecondsToString('Month DAY, YYYY HH:MI:SS.XXX') =May 20, 2011 17:36:48.965

See also