$Sir ND2Date: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
(Automatically generated page update)
 
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="warn"><b>Note: </b>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="warn"><b>Note: </b>Many $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 <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.
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.

Latest revision as of 23:27, 20 September 2018

Convert datetime number of days to string

Note: Many $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

%dat = $Sir_ND2Date(datn, fmt, errctl)

Syntax terms

%dat Set to the datetime value string, using format specified by fmt, corresponding to datn, unless an error is detected.
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".

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