$Sir Date2N: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (link repair)
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:$Sir_Date2N}}
{{DISPLAYTITLE:$Sir_Date2N}}
<span class="pageSubtitle"><section begin="desc" />Convert datetime string to number of seconds/300<section end="desc" /></span>
<span class="pageSubtitle">Convert datetime string to number of seconds/300</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Sir_Date2N function is [[to be entered]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of [[:Category:SOUL object-oriented programming topics|SOUL Object Oriented]] methods. There is currently no OO equivalent for the $Sir_Date2N function.</p>


The <var>$Sir_Date2N</var> function expects a datetime value string and a datetime format string and returns the input datetime converted to the number of 1/300th seconds since 1 January, 1900. It accepts an optional <var>[[Datetime string formats#.24Sir_Datexxx CENTSPAN argument|CENTSPAN]]</var> value and an optional error control string. If an error is detected, the returned value is <code>-9E12</code> (-9000000000000).


The $Sir_Date2N function expects a datetime value string and a datetime format string and returns the input datetime converted to the number of 1/300th seconds 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_Date2N(dat, fmt, span, errctl)
<p class="syntax"><span class="term">%num</span> <span class="literal">= $Sir_Date2N(</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>
<p class="caption">$Sir_Date2N Function
</p>
</p>
where
 
<table class="syntaxTable">
===Syntax terms===
<table>
<tr><th>%num</th>
<td>Set to the value of <var class="term">dat</var>, converted to the number of 1/300th second units 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]] 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>[[Datetime string formats#.24Sir_Datexxx CENTSPAN argument|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 1/300th second units from 1 Jan 1900 12:00 AM.
</td></tr></table>


==Usage notes==
<ul>
<li>Values returned by <var>$Sir_Date2N</var> often exceed the range that can be represented in a 4-byte integer, so you should probably avoid storing the value in a <var>BINARY</var> or <var>FLOAT4</var> field. </li>


For example, the following fragment prints the value <tt>Before</tt>:
<li>Dates prior to 1 January 1900 return a negative number. </li>  
<p class="code"> IF $Sir_Date2N('121494', 'MMDDYY') < -
$Sir_Date2N('040195', 'MMDDYY') THEN
PRINT 'Before'
END IF
</p>


<li>The inverse of this $function is <var>[[$Sir_N2Date]]</var>. </li>


Error conditions are shown in the following figure (see the discussion in ).<p>
<li><var>$Sir_Date2N</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></li>
</ul>


<li>'''fmt''' is not a valid datetime format.
==Example==
The following fragment prints the value <code>Before</code>:


<li>'''dat''' does not match '''fmt'''.
<p class="code">If $Sir_Date2N('121494', 'MMDDYY') < $Sir_Date2N('040195', 'MMDDYY') Then
 
Print 'Before'
<li>'''dat''' is outside of range permitted for '''fmt'''.
End If
 
<li>'''span''' is invalid.
 
</ul>
</p>
</p>
<p class="caption"> $Sir_Date2N returns the value -9E12 (-9000000000000) in the following cases:</p>
Notes:
<ul>
<li>Values returned by $Sir_Date2N will often exceed the range that can be represented in a 4-byte integer, so you should probably avoid storing the value in a BINARY or FLOAT4 field.
<li>Dates prior to 1 January 1900 will return a negative number.
<li>The inverse of this $function is $Sir_N2Date.
</ul>


==Products authorizing {{PAGENAMEE}}==
<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Janus Open Client]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Janus Open Server]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Janus Web Server]]</li>
<li>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
 
<li>[[Sir2000 User Language Tools]]</li>
<li>''[[Sir2000 User Language Tools]]''
</ul>
</ul>
<p class="caption">Products authorizing $Sir_Date2N
</p>




[[Category:$Functions|$Sir_Date2N]]
[[Category:$Functions|$Sir_Date2N]]

Latest revision as of 22:52, 8 February 2018

Convert datetime string to number of seconds/300

Note: Many $functions have been deprecated in favor of SOUL Object Oriented methods. There is currently no OO equivalent for the $Sir_Date2N function.

The $Sir_Date2N function expects a datetime value string and a datetime format string and returns the input datetime converted to the number of 1/300th seconds 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

%num = $Sir_Date2N(dat, fmt, [span], [errctl])

Syntax terms

%num Set to the value of dat, converted to the number of 1/300th second units 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_Date2N often exceed the range that can be represented in a 4-byte integer, so you should probably avoid storing the value in a BINARY or FLOAT4 field.
  • Dates prior to 1 January 1900 return a negative number.
  • The inverse of this $function is $Sir_N2Date.
  • $Sir_Date2N 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 Before:

If $Sir_Date2N('121494', 'MMDDYY') < $Sir_Date2N('040195', 'MMDDYY') Then Print 'Before' End If

Products authorizing $Sir_Date2N

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