$Sir NM2Date: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 4: | Line 4: | ||
<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="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> | ||
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. $ | 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== | ||
Line 10: | Line 10: | ||
<p class="syntax"><section begin="syntax" /> %dat = $Sir_NM2Date(datn, fmt, errctl) | <p class="syntax"><section begin="syntax" /> %dat = $Sir_NM2Date(datn, fmt, errctl) | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
===Syntax terms=== | |||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>datn</th> | <tr><th>datn</th> | ||
<td> | <td>Datetime number containing a signed number of milliseconds since January 1, 1900.</td></tr> | ||
<tr><th>fmt</th> | <tr><th>fmt</th> | ||
<td> | <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> | <td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|"Datetime error handling"]].</td></tr> | ||
<tr><th>%dat</th> | <tr><th>%dat</th> | ||
<td> | <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> | </td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
< | <ul> | ||
<li>The inverse of this $function is <var>[[$Sir_Date2NM]]</var>. | |||
<li>$Sir_NM2Date returns a null string in the following cases (see the discussion in [[Datetime string formats#Datetime error handling|"Datetime error handling"]]): | |||
< | |||
<ul> | <ul> | ||
<li> | <li><var calss="term">fmt</var> is not a valid datetime format. | ||
<li> | <li><var class="term"datn</var> out of range. | ||
</ul> | </ul> | ||
==Example== | |||
The following fragment prints the string <tt>07/31/84</tt>: | |||
<p class="code">%X = $Sir_Date2NM('8407301230', 'YYMMDDHHMI') | |||
+ Add 15 hours: | |||
%X = %X + 1000 * 60 * 60 * 15 | |||
PRINT $Sir_NM2Date(%X, 'MM/DD/YY') | |||
</p> | </p> | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> |
Revision as of 21:19, 8 February 2012
Convert datetime number of milliseconds to string
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no OO equivalent for the $Sir_NM2Date function.
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
<section begin="syntax" /> %dat = $Sir_NM2Date(datn, fmt, errctl) <section end="syntax" />
Syntax terms
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". |
%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_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.
- <var class="term"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')