$Sir NM2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(36 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Convert datetime number of milliseconds to string</span>
<span class="pageSubtitle">Convert datetime number of milliseconds to string</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_NM2Date function.</p>
<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 $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.
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==
==Syntax==


<p class="syntax"><section begin="syntax" /> %dat = $Sir_NM2Date(datn, fmt, errctl)
<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>
<section end="syntax" /></p>
<p class="caption">$Sir_NM2Date Function
</p>
</p>


where
===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>datetime number containing a signed number of milliseconds since January 1, 1900.</td></tr>
<td>Datetime number containing a signed number of milliseconds since January 1, 1900.</td></tr>
<tr><th>fmt</th>
<tr><th>fmt</th>
<td>datetime format string. Refer to for an explanation of valid datetime formats and valid datetime values.</td></tr>
<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>optional error control string, refer to .</td></tr>
<td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|Datetime error handling]].</td></tr>
<tr><th>%dat</th>
<td>set to the datetime value string, using format specified by '''fmt''', corresponding to '''datn''', unless an error is detected.
</td></tr>
</table>
</table>


For example, the following fragment prints the string <tt>07/31/84</tt>:
==Usage notes==
<p class="code"> %X = $Sir_Date2NM('8407301230', 'YYMMDDHHMI')
<ul>
* Add 15 hours:
<li>The inverse of this $function is <var>[[$Sir_Date2NM]]</var>. </li>
%X = %X + 1000 * 60 * 60 * 15
PRINT $Sir_NM2Date(%X, 'MM/DD/YY')
</p>


Error conditions are shown in the following figure (see the discussion in ).<p>
<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>'''fmt''' is not a valid datetime format.
<li><var class="term">fmt</var> is not a valid datetime format. </li>
<li>'''datn''' out of range.
<li><var class="term">datn</var> out of range. </li>
</ul>
</ul>
</ul>
==Example==
The following fragment prints the string <tt>07/31/84</tt>:
<p class="code">%X = $Sir_Date2NM('8407301230', 'YYMMDDHHMI')
&#42; Add 15 hours:
%X = %X + 1000 * 60 * 60 * 15
PRINT $Sir_NM2Date(%X, 'MM/DD/YY')
</p>
</p>
<p class="caption"> $Sir_NM2Date returns a null string in the following cases:</p>
Notes:  The inverse of this $function is $Sir_Date2NM.


==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
<li>[[Sir2000 User Language Tools]]</li>
<li>[http://m204wiki.rocketsoftware.com/images/d/d6/Ul2krNew.pdf Sir2000 User Language Tools]</li>
</ul>
</ul>
<p class="caption">Products authorizing $Sir_NM2Date
</p>


[[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')

Products authorizing $Sir_NM2Date