$Sir NS2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
(Automatically generated page update)
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Sir_NS2Date}}
{{DISPLAYTITLE:$Sir_NS2Date}}
<span class="pageSubtitle"><section begin="desc" />Convert datetime number of seconds to string<section end="desc" /></span>
<span class="pageSubtitle">Convert datetime number of seconds to string</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Sir_NS2Date function.</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_NS2Date function is <var>[[SecondsToString (Float function)|SecondsToString]]</var>.</p>


The $Sir_NS2Date function expects a numeric datetime argument containing a number of seconds 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_NS2Date accepts an optional error control string and returns the null string if an error is detected.
The <var>$Sir_NS2Date</var> function expects a numeric datetime argument containing a number of seconds 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_NS2Date</var> accepts an optional error control string and returns the null string if an error is detected.


==Syntax==
==Syntax==
 
<p class="syntax"><span class="term">%dat</span> <span class="literal">= $Sir_NS2Date(</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"><section begin="syntax" /> %dat = $Sir_NS2Date(datn, fmt, errctl)
<section end="syntax" /></p>
<p class="caption">$Sir_NS2Date 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 seconds since January 1, 1900.</td></tr>
<td>Datetime number containing a signed number of seconds 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|"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>:
==Example==
<p class="code"> %X = $Sir_Date2NS('8407301230', 'YYMMDDHHMI')
The following fragment prints the string <tt>07/31/84</tt>:
* Add 15 hours:
<p class="code">%X = $Sir_Date2NS('8407301230', 'YYMMDDHHMI')
%X = %X + 60 * 60 * 15
&#42; Add 15 hours:
PRINT $Sir_NS2Date(%X, 'MM/DD/YY')
%X = %X + 60 * 60 * 15
PRINT $Sir_NS2Date(%X, 'MM/DD/YY')
</p>
</p>


Error conditions are shown in the following figure.
==Usage notes==
<ul>
<li>The inverse of this $function is <var>[[$Sir_Date2NS]]</var>.
<li><var>$Sir_NS2Date</var> returns a null string in the following cases:
<ul>
<ul>
<li>'''fmt''' is not a valid datetime format.
<li><var class="term">fmt</var> is not a valid datetime format.
<li>'''datn''' out of range.
<li><var class="term">datn</var> out of range.
</ul>
</ul>
</ul>
<p class="caption"> $Sir_NS2Date returns a null string in the following cases:</p>


Notes:  The inverse of this $function is $Sir_Date2NS.


==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[List of $functions|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_NS2Date
</p>


[[Category:$Functions|$Sir_NS2Date]]
[[Category:$Functions|$Sir_NS2Date]]

Latest revision as of 23:27, 20 September 2018

Convert datetime number of seconds to string

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_NS2Date function is SecondsToString.

The $Sir_NS2Date function expects a numeric datetime argument containing a number of seconds 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_NS2Date accepts an optional error control string and returns the null string if an error is detected.

Syntax

%dat = $Sir_NS2Date(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 seconds 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".

Example

The following fragment prints the string 07/31/84:

%X = $Sir_Date2NS('8407301230', 'YYMMDDHHMI') * Add 15 hours: %X = %X + 60 * 60 * 15 PRINT $Sir_NS2Date(%X, 'MM/DD/YY')

Usage notes

  • The inverse of this $function is $Sir_Date2NS.
  • $Sir_NS2Date returns a null string in the following cases:
    • fmt is not a valid datetime format.
    • datn out of range.


Products authorizing $Sir_NS2Date