$Sir NM2Date: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Products authorizing {{PAGENAMEE}}: typo) |
||
| (38 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Sir_NM2Date}} | {{DISPLAYTITLE:$Sir_NM2Date}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Convert datetime number of milliseconds to string</span> | ||
<p class=" | <p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$Sir_NM2Date</var> function is <var>[[MillisecondsToString (Float function)|MillisecondsToString]]</var>.</p> | ||
The <var>$Sir_NM2Date</var> function expects a numeric datetime argument containing a number of milliseconds since January 1, 1900, and a datetime format string. It returns the date represented by the first argument, in the format corresponding to the second argument. <var>$Sir_NM2Dat</var>e accepts an optional error control string and returns the null string if an error is detected. | |||
==Syntax== | |||
<p class="syntax"><span class="term">%dat</span> <span class="literal">= $Sir_NM2Date(</span><span class="term">datn</span><span class="literal">,</span> <span class="term">fmt</span><span class="literal">,</span> <span class="term">errctl</span><span class="literal">)</span> | |||
<p class="syntax">< | |||
< | |||
< | |||
</p> | </p> | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%dat</th> | |||
<td>Set to the datetime value string, using format specified by <var class="term">fmt</var>, corresponding to <var class="term">datn</var>, unless an error is detected. | |||
</td></tr> | |||
<tr><th>datn</th> | <tr><th>datn</th> | ||
<td> | <td>Datetime number containing a signed number of milliseconds since January 1, 1900.</td></tr> | ||
<tr><th>fmt</th> | <tr><th>fmt</th> | ||
<td> | <td>Datetime format string. Refer to [[Datetime string formats]] for an explanation of valid datetime formats and valid datetime values.</td></tr> | ||
<tr><th>errctl</th> | <tr><th>errctl</th> | ||
<td> | <td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|Datetime error handling]].</td></tr> | ||
</table> | |||
</td></tr></table> | |||
==Usage notes== | |||
<ul> | |||
<li>The inverse of this $function is <var>[[$Sir_Date2NM]]</var>. </li> | |||
<li><var>$Sir_NM2Date</var> returns a null string in the following cases (see the discussion in [[Datetime string formats#Datetime error handling|Datetime error handling]]): | |||
< | |||
</ | |||
<ul> | <ul> | ||
<li><var class="term">fmt</var> is not a valid datetime format. </li> | |||
<li><var class="term">datn</var> out of range. </li> | |||
</ul> | |||
</ul> | |||
< | ==Example== | ||
The following fragment prints the string <tt>07/31/84</tt>: | |||
< | <p class="code">%X = $Sir_Date2NM('8407301230', 'YYMMDDHHMI') | ||
* Add 15 hours: | |||
%X = %X + 1000 * 60 * 60 * 15 | |||
PRINT $Sir_NM2Date(%X, 'MM/DD/YY') | |||
</p> | </p> | ||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius | <li>[[Sirius Functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
<li>[http://m204wiki.rocketsoftware.com/images/d/d6/Ul2krNew.pdf Sir2000 User Language Tools]</li> | |||
<li> | |||
</ul> | </ul> | ||
[[Category:$Functions|$Sir_NM2Date]] | [[Category:$Functions|$Sir_NM2Date]] | ||
Latest revision as of 19:15, 2 February 2018
Convert datetime number of milliseconds to string
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_NM2Date function is MillisecondsToString.
The $Sir_NM2Date function expects a numeric datetime argument containing a number of milliseconds since January 1, 1900, and a datetime format string. It returns the date represented by the first argument, in the format corresponding to the second argument. $Sir_NM2Date accepts an optional error control string and returns the null string if an error is detected.
Syntax
%dat = $Sir_NM2Date(datn, fmt, errctl)
Syntax terms
| %dat | Set to the datetime value string, using format specified by fmt, corresponding to datn, unless an error is detected. |
|---|---|
| datn | Datetime number containing a signed number of milliseconds since January 1, 1900. |
| fmt | Datetime format string. Refer to Datetime string formats for an explanation of valid datetime formats and valid datetime values. |
| errctl | Optional error control string; refer to Datetime error handling. |
Usage notes
- The inverse of this $function is $Sir_Date2NM.
- $Sir_NM2Date returns a null string in the following cases (see the discussion in Datetime error handling):
- fmt is not a valid datetime format.
- datn out of range.
Example
The following fragment prints the string 07/31/84:
%X = $Sir_Date2NM('8407301230', 'YYMMDDHHMI') * Add 15 hours: %X = %X + 1000 * 60 * 60 * 15 PRINT $Sir_NM2Date(%X, 'MM/DD/YY')