$Sir NS2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 12: Line 12:
===Syntax terms===
===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>
Line 18: Line 21:
<tr><th>errctl</th>
<tr><th>errctl</th>
<td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|"Datetime error handling"]].</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 <var class="term">fmt/var>, corresponding to <var class="term">datn</var>, unless an error is detected.
</td></tr>
</table>
</table>



Revision as of 22:50, 8 February 2012

Convert datetime number of seconds to string

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

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

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

Syntax terms

%dat Set to the datetime value string, using format specified by fmt/var>, 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