$Sir_ND2Date

From m204wiki
Revision as of 20:16, 6 February 2012 by Dme (talk | contribs) (→‎Syntax)
Jump to navigation Jump to search

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" />

$Sir_ND2Date Function

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.

$Sir_ND2Date returns a null string in the following cases:

Notes: The inverse of this $function is $Sir_Date2ND.

Products authorizing $Sir_ND2Date