$Sir_NM2Date

From m204wiki
Revision as of 21:38, 8 February 2012 by JAL2 (talk | contribs) (→‎Usage notes)
Jump to navigation Jump to search

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

Syntax terms

datn Datetime number containing a signed number of milliseconds 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_Date2NM.
  • $Sir_NM2Date returns a null string in the following cases (see the discussion in "Datetime error handling"):
    • fmt is not a valid datetime format.
    • datn out of range.

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')


Products authorizing $Sir_NM2Date