$Sir ND2Date: Difference between revisions
m (1 revision) |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle">Convert datetime number of days to string</span> | <span class="pageSubtitle">Convert datetime number of days to string</span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <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 $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. |
Revision as of 20:15, 6 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" />
where
datn | datetime number containing a signed number of days 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_Date2ND('8407301230', 'YYMMDDHHMI') * Add a day: %X = %X + 1 PRINT $Sir_ND2Date(%X, 'MM/DD/YY')
Error conditions are shown in the following figure.
- fmt is not a valid datetime format.
- datn out of range.
Notes: The inverse of this $function is $Sir_Date2ND.