$Sir Date2ND: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 4: Line 4:
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Date2ND function is <var>[[StringToDays (String function)]]</var>.</p>
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Date2ND function is <var>[[StringToDays (String function)]]</var>.</p>


The <var>$Sir_Date2ND</var> 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 <code>-9E12</code> (-9000000000000).


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==
==Syntax==
<p class="syntax"><section begin="syntax" /> %num = $Sir_Date2ND(dat, fmt, span, errctl)
<p class="syntax"><section begin="syntax" /> %num = $Sir_Date2ND(dat, fmt, span, errctl)
<section end="syntax" /></p>
<section end="syntax" /></p>
<p class="caption">$Sir_Date2ND Function
 
</p>
===Syntax terms===
where
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%num</th>
<td>Set to the value of <var class="term">dat</var>, converted to the number of days from 1 Jan 1900 12:00 AM.
</td></tr>
<tr><th>dat</th>
<tr><th>dat</th>
<td>datetime value string.</td></tr>
<td>Datetime value string.</td></tr>
<tr><th>fmt</th>
<tr><th>fmt</th>
<td>datetime format string corresponding to '''dat'''. Refer to for an explanation of valid datetime formats and valid dates. Non-strict matching is used for input format '''fmt'''; see .</td></tr>
<td>Datetime format string corresponding to <var class="term">dat</var>. Refer to [[Datetime string formats|"Datetime string formats"]] for an explanation of valid datetime formats and valid dates. Non-strict matching is used for input format <var class="term">fmt</var>; see [[Datetime string formats#Strict and non-strict format matching|"Strict and non-strict format matching"]].</td></tr>
<tr><th>span</th>
<tr><th>span</th>
<td>optional CENTSPAN value, default is -50. </td></tr>
<td>Optional <var>CENTSPAN</var> value, default is -50. </td></tr>
<tr><th>errctl</th>
<tr><th>errctl</th>
<td>optional error control string, refer to .</td></tr>
<td>Optional error control string; refer to [[Datetime string formats#Datetime error handling|"Datetime error handling"]].</td></tr>
<tr><th>%num</th>
</table>
<td>set to the value of '''dat''', converted to the number of days from 1 Jan 1900 12:00 AM.
</td></tr></table>
 
 
For example, the following fragment prints the value <tt>12</tt>:
<p class="code"> %A = $Sir_Date2ND('010695', 'MMDDYY')
%B = $Sir_Date2ND('122594', 'MMDDYY')
%C = %A - %B
PRINT %C
</p>
 
 
Error conditions are shown in the following figure (see the discussion in ).<p>


==Usage notes==
<ul>
<li>Values returned by <var>$Sir_Date2ND</var> can be stored in a <var>BINARY</var> or <var>FLOAT4</var> field, if you want.
<li>Dates prior to 1 January 1900 will return a negative number.
<li>The inverse of this $function is <var>[[$Sir_ND2Date]]</var>.
<li><var>$Sir_Date2ND</var> returns the value <code>-9E12</code> (-9000000000000) in the following cases (see the discussion in [[Datetime string formats#Datetime error handling|"Datetime error handling"]]):
<ul>
<ul>
<li><var class="term">fmt</var> is not a valid datetime format.
<li><var class="term">dat</var> does not match <var class="term">fmt</var>.
<li><var class="term">dat</var> is outside of range permitted for <var class="term">fmt</var>.
<li><var class="term">span</var> is invalid.
</ul>
</ul>


<li>'''fmt''' is not a valid datetime format.
==Example==
 
The following fragment prints the value <code>12</code>:
<li>'''dat''' does not match '''fmt'''.
<p class="code">%a = $Sir_Date2ND('010695', 'MMDDYY')
 
%b = $Sir_Date2ND('122594', 'MMDDYY')
<li>'''dat''' is outside of range permitted for '''fmt'''.
%c = %a - %b
 
Print %c
<li>'''span''' is invalid.
 
</ul>
</p>
</p>
<p class="caption"> $Sir_Date2ND returns the value -9E12 (-9000000000000) in the following cases:</p>


Notes:
<ul>
<li>Values returned by $Sir_Date2ND can be stored in a BINARY or FLOAT4 field, if you wish.
<li>Dates prior to 1 January 1900 will return a negative number.
<li>The inverse of this $function is <var>[[$Sir_ND2Date]]</var>.
</ul>


<ul class="smallAndTightList">
<ul class="smallAndTightList">

Revision as of 22:29, 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


Products authorizing $Sir_Date2ND

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Sir_Date2ND&oldid=30568"