$Sir_NS2Date

From m204wiki
Revision as of 17:36, 28 January 2011 by 198.242.244.47 (talk) (Created page with "{{DISPLAYTITLE:$Sir_NS2Date}} <span class="pageSubtitle"><section begin="desc" />Convert datetime number of seconds to string<section end="desc" /></span> <p class="warning">Mos...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

<section begin="desc" />Convert datetime number of seconds to string<section end="desc" />

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_NS2Date function is to be entered.


The $Sir_NS2Date function expects a numeric datetime argument containing a number of seconds 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_NS2Date accepts an optional error control string and returns the null string if an error is detected.

Syntax

<section begin="syntax" /> %dat = $Sir_NS2Date(datn, fmt, errctl) <section end="syntax" />

$Sir_NS2Date Function

where

datn datetime number containing a signed number of seconds 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_Date2NS('8407301230', 'YYMMDDHHMI') * Add 15 hours: %X = %X + 60 * 60 * 15 PRINT $Sir_NS2Date(%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.

$Sir_NS2Date returns a null string in the following cases:


Notes:

The inverse of this $function is $Sir_Date2NS.

Products authorizing $Sir_NS2Date