$Sir ND2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 4: Line 4:
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for this $function is <var>[[DaysToString (Float function)|DaysToString]]</var>.</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for this $function is <var>[[DaysToString (Float function)|DaysToString]]</var>.</p>


The $Sir_ND2Date function expects a numeric datetime argument containing a number of days 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_ND2Date accepts an optional error control string and returns the null string if an error is detected.
The <var>$Sir_ND2Date</var> function expects a numeric datetime argument containing a number of days 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_ND2Date</var> 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_ND2Date(datn, fmt, errctl)
<p class="syntax"><section begin="syntax" /> %dat = $Sir_ND2Date(datn, fmt, errctl)
<section end="syntax" /></p>
<section end="syntax" /></p>
<p class="caption">$Sir_ND2Date Function
</p>
where


===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>datn</th>
<tr><th>datn</th>
<td>datetime number containing a signed number of days since January 1, 1900.</td></tr>
<td>Datetime number containing a signed number of days 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>
<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 <var class="term">fmt</var>, corresponding to <var class="term">datn</var>, unless an error is detected.
</td></tr>
</td></tr>
</table>
</table>


For example, the following fragment prints the string <tt>07/31/84</tt>:
==Usage notes==
<p class="code"> %X = $Sir_Date2ND('8407301230', 'YYMMDDHHMI')
<ul>
* Add a day:
<li>The inverse of this $function is <var>[[$Sir_Date2ND]]</var>.
%X = %X + 1
<li><var>$Sir_ND2Date</var> returns a null string in the following cases:
PRINT $Sir_ND2Date(%X, 'MM/DD/YY')
</p>
 
Error conditions are shown in the following figure.<p>
<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>
==Example==
The following fragment prints the string <code>07/31/84</code>:
<p class="code">%x = $Sir_Date2ND('8407301230', 'YYMMDDHHMI')
&#43; Add a day:
%x = %x + 1
Print $Sir_ND2Date(%X, 'MM/DD/YY')
</p>
</p>
<p class="caption"> $Sir_ND2Date returns a null string in the following cases:</p>


Notes:  The inverse of this $function is <var>[[$Sir_Date2ND]]</var>.


<ul class="smallAndTightList">
<ul class="smallAndTightList">

Revision as of 21:47, 8 February 2012

Convert datetime number of days to string

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for this $function is DaysToString.

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

Syntax

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

Syntax terms

datn Datetime number containing a signed number of days 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_Date2ND.
  • $Sir_ND2Date returns a null string in the following cases:
    • fmt is not a valid datetime format.
    • datn out of range.

Example

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

%x = $Sir_Date2ND('8407301230', 'YYMMDDHHMI') + Add a day: %x = %x + 1 Print $Sir_ND2Date(%X, 'MM/DD/YY')


Products authorizing $Sir_ND2Date

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