TimeStringConvert (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 12: Line 12:
<td>The datetime format of the method object <var class="term">string</var>.</td></tr>
<td>The datetime format of the method object <var class="term">string</var>.</td></tr>
<tr><th>outputFormat</th>
<tr><th>outputFormat</th>
<td>A string that is the format to which the method object is to be converted.</td></tr>
<td>A string that specifies the datetime format to which the method object is to be converted.</td></tr>
<tr><th><var>CentSpan</var></th>
<tr><th><var>CentSpan</var></th>
<td>This [[Notation conventions for methods#Named parameters|name allowed]] parameter is the <var>[[Datetime string formats#CENTSPAN|CENTSPAN]]</var> value used, if the <var class="term">format</var> has a two-digit year. The default is specified by the <var class="camel">[[CENTSPAN parameter|CENTSPAN parameter]]</var>. </td></tr>
<td>This [[Notation conventions for methods#Named parameters|name allowed]] parameter is the <var>[[Datetime string formats#CENTSPAN|CENTSPAN]]</var> value used, if the <var class="term">format</var> has a two-digit year. The default is specified by the <var class="camel">[[CENTSPAN parameter|CENTSPAN parameter]]</var>. </td></tr>

Revision as of 22:07, 3 April 2012

Convert date/time string from one format to another (String class)

[Introduced in Sirius Mods 7.9]


Syntax

%outString = string:TimeStringConvert( inputFormat, outputFormat, - [[CentSpan=] number]) Throws InvalidDateString

Syntax terms

%outString This string is the method object, string, converted to the format in outputFormat.
string A datetime string.
inputFormat The datetime format of the method object string.
outputFormat A string that specifies the datetime format to which the method object is to be converted.
CentSpan This name allowed parameter is the CENTSPAN value used, if the format has a two-digit year. The default is specified by the CENTSPAN parameter.

Examples

  1. This statement converts a value in YYYYMMDDHHMISSXXX format to the Month DAY, YYYY HH:MI:SS.XXX format:

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

    The result is:

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

  2. This statement converts a value in MM/DD/YY format to the Month DAY, YYYY format:

    printText {~='12/22/11':timeStringConvert('MM/DD/YY', 'Month DAY, YYYY', centspan=1910)}

    The result is:

    '12/22/11':timeStringConvert('MM/DD/YY', 'Month DAY, YYYY', centspan=1910)=December 22, 1911

See also