$Sir N2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Convert datetime number of seconds/300 to string<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Convert datetime number of seconds/300 to string<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_N2Date function is [[to be entered]].</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_N2Date function.</p>
 


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


The $Sir_N2Date function expects a numeric datetime argument containing a number of seconds/300 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_N2Date 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_N2Date(datn, fmt, errctl)
<p class="syntax"><section begin="syntax" /> %dat = $Sir_N2Date(datn, fmt, errctl)
Line 12: Line 11:
<p class="caption">$Sir_N2Date Function
<p class="caption">$Sir_N2Date Function
</p>
</p>
where
where
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>datn</th>
<tr><th>datn</th>
Line 22: Line 23:
<tr><th>%dat</th>
<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>set to the datetime value string, using format specified by '''fmt''', corresponding to '''datn''', unless an error is detected.
</td></tr></table>
</td></tr>
</table>


For example, the following fragment prints the string <tt>07/31/84</tt>:


For example, the following fragment prints the string <tt>07/31/84</tt>:
<p class="code"> %X = $Sir_Date2N('8407301230', 'YYMMDDHHMI')
<p class="code"> %X = $Sir_Date2N('8407301230', 'YYMMDDHHMI')
  * Add 15 hours:
  * Add 15 hours:
Line 31: Line 33:
  PRINT $Sir_N2Date(%X, 'MM/DD/YY')
  PRINT $Sir_N2Date(%X, 'MM/DD/YY')
</p>
</p>


Error conditions are shown in the following figure (see the discussion in ).<p>
Error conditions are shown in the following figure (see the discussion in ).<p>
   
   
<ul>
<ul>
<li>'''fmt''' is not a valid datetime format.
<li>'''fmt''' is not a valid datetime format.
<li>'''datn''' out of range.
<li>'''datn''' out of range.
</ul>
</ul>
</p>
</p>
<p class="caption"> $Sir_N2Date returns a null string in the following cases:</p>
<p class="caption"> $Sir_N2Date returns a null string in the following cases:</p>


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


Notes:
The inverse of this $function is $Sir_Date2N.
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[Sirius functions]]</li>
Line 59: Line 54:
<li>[[Japanese functions]]</li>
<li>[[Japanese functions]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
 
<li>[[Sir2000 User Language Tools]]</li>
<li>''[[Sir2000 User Language Tools]]''
</ul>
</ul>
<p class="caption">Products authorizing $Sir_N2Date
<p class="caption">Products authorizing $Sir_N2Date
</p>
</p>


[[Category:$Functions|$Sir_N2Date]]
[[Category:$Functions|$Sir_N2Date]]

Revision as of 19:29, 8 February 2011

<section begin="desc" />Convert datetime number of seconds/300 to string<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_N2Date function.

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

Syntax

<section begin="syntax" /> %dat = $Sir_N2Date(datn, fmt, errctl) <section end="syntax" />

$Sir_N2Date Function

where

datn datetime number containing a signed number of seconds/300 since January 1, 1900.
fmt datetime format string. Refer to for an explanation of valid datetime formats and valid datetime values.
errctl optional error control string, refer to .
%dat set to the datetime value string, using format specified by fmt, corresponding to datn, unless an error is detected.

For example, the following fragment prints the string 07/31/84:

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

Error conditions are shown in the following figure (see the discussion in ).

  • fmt is not a valid datetime format.
  • datn out of range.

$Sir_N2Date returns a null string in the following cases:

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

Products authorizing $Sir_N2Date

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Sir_N2Date&oldid=30679"