$Sir Date2ND: Difference between revisions
mNo edit summary |
m (→Syntax) |
||
Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax"><section begin="syntax" /> %num = $Sir_Date2ND(dat, fmt, span, errctl) | <p class="syntax"><section begin="syntax" /><span class="term">%num</span> <span class="literal">= $Sir_Date2ND(</span><span class="term">dat</span><span class="literal">,</span> <span class="term">fmt</span><span class="literal">,</span> <span class="term">span</span><span class="literal">,</span> <span class="term">errctl</span><span class="literal">)</span> | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
Revision as of 23:19, 8 February 2012
Convert datetime string to number of days
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Date2ND function is StringToDays (String function).
The $Sir_Date2ND function expects a datetime value string and a datetime format string and returns the input datetime converted to the number of days since 1 January, 1900. It accepts an optional CENTSPAN value and an optional error control string. If an error is detected, the returned value is -9E12
(-9000000000000).
Syntax
<section begin="syntax" />%num = $Sir_Date2ND(dat, fmt, span, errctl) <section end="syntax" />
Syntax terms
%num | Set to the value of dat, converted to the number of days from 1 Jan 1900 12:00 AM. |
---|---|
dat | Datetime value string. |
fmt | Datetime format string corresponding to dat. Refer to "Datetime string formats" for an explanation of valid datetime formats and valid dates. Non-strict matching is used for input format fmt; see "Strict and non-strict format matching". |
span | Optional CENTSPAN value, default is -50. |
errctl | Optional error control string; refer to "Datetime error handling". |
Usage notes
- Values returned by $Sir_Date2ND can be stored in a BINARY or FLOAT4 field, if you want.
- Dates prior to 1 January 1900 will return a negative number.
- The inverse of this $function is $Sir_ND2Date.
- $Sir_Date2ND returns the value
-9E12
(-9000000000000) in the following cases (see the discussion in "Datetime error handling"):- fmt is not a valid datetime format.
- dat does not match fmt.
- dat is outside of range permitted for fmt.
- span is invalid.
Example
The following fragment prints the value 12
:
%a = $Sir_Date2ND('010695', 'MMDDYY') %b = $Sir_Date2ND('122594', 'MMDDYY') %c = %a - %b Print %c