$Sir NM2Date: Difference between revisions
mNo edit summary |
m (1 revision) |
(No difference)
|
Revision as of 21:22, 22 November 2011
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" />
where
datn | datetime number containing a signed number of milliseconds 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_Date2NM('8407301230', 'YYMMDDHHMI') * Add 15 hours: %X = %X + 1000 * 60 * 60 * 15 PRINT $Sir_NM2Date(%X, 'MM/DD/YY')
Error conditions are shown in the following figure (see the discussion in ).
- fmt is not a valid datetime format.
- datn out of range.
Notes: The inverse of this $function is $Sir_Date2NM.