$Sir NS2Date: Difference between revisions

Revision as of 01:02, 19 October 2012

Convert datetime number of seconds to string

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

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

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 seconds 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".

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

Usage notes

The inverse of this $function is $Sir_Date2NS.
$Sir_NS2Date returns a null string in the following cases:
- fmt is not a valid datetime format.
- datn out of range.

Products authorizing $Sir_NS2Date

@@ Line 2: / Line 2: @@
 <span class="pageSubtitle">Convert datetime number of seconds to string</span>
-<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_NS2Date function is <var>[[SecondsToString (Float function)|SecondsToString]]</var>.</p>
+<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$Sir_NS2Date</var> function is <var>[[SecondsToString (Float function)|SecondsToString]]</var>.</p>
 The <var>$Sir_NS2Date</var> 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. <var>$Sir_NS2Date</var> accepts an optional error control string and returns the null string if an error is detected.