$Sir N2Date: Difference between revisions

Revision as of 21:10, 8 February 2012

Convert datetime number of seconds/300 to string

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" />

Syntax terms

datn	Datetime number containing a signed number of seconds/300 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".
%dat	Set to the datetime value string, using format specified by fmt, corresponding to datn, unless an error is detected.

Usage notes

The inverse of this $function is $Sir_Date2N.
$Sir_N2Date 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_Date2N('8407301230', 'YYMMDDHHMI') * Add 15 hours: %x = %x + 300 * 60 * 60 * 15 Print $Sir_N2Date(%X, 'MM/DD/YY')

Products authorizing $Sir_N2Date

@@ Line 9: / Line 9: @@
 <p class="syntax"><section begin="syntax" /> %dat = $Sir_N2Date(datn, fmt, errctl)
 <section end="syntax" /></p>
-<p class="caption">$Sir_N2Date Function
-</p>
-where
+===Syntax terms===
 <table class="syntaxTable">
 <tr><th>datn</th>
-<td>datetime number containing a signed number of seconds/300 since January 1, 1900.</td></tr>
+<td>Datetime number containing a signed number of seconds/300 since January 1, 1900.</td></tr>
 <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>
-<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>Set to the datetime value string, using format specified by '''fmt''', corresponding to '''datn''', unless an error is detected.
 </td></tr>
 </table>
-For example, the following fragment prints the string <tt>07/31/84</tt>:
+==Usage notes==
+<ul>
+<li>The inverse of this $function is <var>[[$Sir_Date2N]]</var>.
+<li><var>$Sir_N2Date</var> returns a null string in the following cases (see the discussion in [[Datetime string formats#Datetime error handling|"Datetime error handling"]]):
+<ul>
+<li><var class="term">fmt</var> is not a valid datetime format.
+<li><var class="term">datn</var> out of range.
+</ul>
+</ul>
-<p class="code"> %X = $Sir_Date2N('8407301230', 'YYMMDDHHMI')
+==Example==
- * Add 15 hours:
+The following fragment prints the string <code>07/31/84</code>:
- %X = %X + 300 * 60 * 60 * 15
- PRINT $Sir_N2Date(%X, 'MM/DD/YY')
-</p>
-Error conditions are shown in the following figure (see the discussion in ).<p>
+<p class="code">%x = $Sir_Date2N('8407301230', 'YYMMDDHHMI')
+&#42; Add 15 hours:
-<ul>
+%x = %x + 300 * 60 * 60 * 15
-<li>'''fmt''' is not a valid datetime format.
+Print $Sir_N2Date(%X, 'MM/DD/YY')
-<li>'''datn''' out of range.
-</ul>
 </p>
-<p class="caption"> $Sir_N2Date returns a null string in the following cases:</p>
-Notes:   The inverse of this $function is $Sir_Date2N.
 <ul class="smallAndTightList">