$DateDif: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Deleted PROCEDURE DATE_DIFFERENCE ... END PROCEDURE Add right parentheses)
m (minor cleanup)
Line 1: Line 1:
<p>The $DATEDIF function returns the difference in days between the two dates. </p>
<p>
<b>Syntax</b>
The <var>$Datedif</var> function returns the difference in days between two dates. </p>
<p>The format of the $DATEDIF function is:</p>
 
<p class="code">$DATEDIF(date-1-format,date-1,date-2-format,date-2,defcent,centsplt)</p>
====Syntax====
<p>where:</p>
<p>
The format of the <var>$Datedif</var> function is:</p>
<p class="syntax">$Datedif(<span class="term">date-1-format</span>, <span class="term">date-1</span>, <span class="term">date-2-format</span>, <span class="term">date-2</span>, <span class="term">defcent</span>, <span class="term">centsplt</span>)</p>
<p>
Where:</p>
<ul>
<ul>
<li>Date-1-format specifies the format of the first date. The format can be a combination of these elements:  </li>
<li><var class="term">date-1-format</var> specifies the format of the first date. The format can be a combination of these elements:   
<table>
<table>
<tr>
<tr>
Line 11: Line 15:
<td>Gregorian numeric day</td>
<td>Gregorian numeric day</td>
</tr>
</tr>
<tr>
<tr>
<td>DDD</td>
<td>DDD</td>
<td>Julian numeric date</td>
<td>Julian numeric date</td>
</tr>
</tr>
<tr>
<tr>
<td>MM</td>
<td>MM</td>
<td>Numeric month</td>
<td>Numeric month</td>
</tr>
</tr>
<tr>
<tr>
<td>MON</td>
<td>MON</td>
<td>Abbreviated month name</td>
<td>Abbreviated month name</td>
</tr>
</tr>
<tr>
<tr>
<td>MONTH</td>
<td>MONTH</td>
<td>Full month name</td>
<td>Full month name</td>
</tr>
</tr>
<tr>
<tr>
<td>YY</td>
<td>YY</td>
<td>Last two digits of numeric year (assumes that the year prefix is 19)</td>
<td>Last two digits of numeric year (assumes that the year prefix is 19)</td>
</tr>
</tr>
<tr>
<tr>
<td>YYYY</td>
<td>YYYY</td>
<td>Full numeric year </td>
<td>Full numeric year </td>
</tr>
</tr>
<tr>
<tr>
<td>CYY</td>
<td>CYY</td>
Line 40: Line 51:
</tr>
</tr>
</table>
</table>
<p>Valid formats are:</p>
<p>
</li>
Valid formats are:</p>
<ul>
<li>A format that has a month, day, and year element</li>
<li>A Julian date format that has a year element and a day element in the format DDD </li>
</ul>
</ul>
<p>A format that has a month, day, and year element</p>
<p>
<p>A Julian date format that has a year element and a day element in the format DDD </p>
Any EBCDIC characters except single quotes are allowed within the input format and appear unchanged in the output date. The input format can be as many as 32 characters in length. </p>
<p>Any EBCDIC characters except single quotes are allowed within the input format and appear unchanged in the output date. The input format can be as many as 32 characters in length. </p>
<ul>
<li>Date-1 specifies the first date in the format specified by the date-1-format argument. The date can be as many as 36 characters in length. </li>
</li>
</li>
<li>Date-2-format specifies the format of the second date. The format requirements are the same as those for the date-1-format argument. This argument can be omitted but the comma after it is required. If this argument is omitted, $DATEDIF assumes that date-2 is in the same format as date-1. </li>
 
<li><var class="term">date-1</var> specifies the first date in the format specified by the <var class="term">date-1-format</var> argument. The date can be as many as 36 characters in length. </li>
</li>
</li>
<li>Date-2 specifies the second date. The date must be either in the format specified in the date-2-format argument, or in the format specified in date-1-format if date-2-format is not specified. The date can be as many as 36 characters in length.</li>
 
<li><var class="term">date-2-format</var> specifies the format of the second date. The format requirements are the same as those for the <var class="term">date-1-format</var> argument. This argument can be omitted but the comma after it is required. If this argument is omitted, <var>$Datedif</var> assumes that <var class="term">date-2</var> is in the same format as <var class="term">date-1</var>. </li>
</li>
</li>
<li>The defcent argument (optional) specifies the DEFCENT value to use; it overrides all other DEFCENT and CENTSPLT parameter values. This argument cannot be specified with the centsplt argument, unless one of the values is NULL.</li>
 
<li><var class="term">date-2</var> specifies the second date. The date must be either in the format specified in the <var class="term">date-2-format</var> argument, or in the format specified in <var class="term">date-1-format</var> if <var class="term">date-2-format</var> is not specified. The date can be as many as 36 characters in length.</li>
</li>
</li>
<li>The centsplt argument (optional) specifies the CENTSPLIT value to use; it overrides all other DEFCENT and CENTSPLT parameter values. This argument cannot be specified with the defcent argument, unless one of the values is NULL.</li>
 
<li>The <var class="term">defcent</var> argument (optional) specifies the <var>[[DEFCENT parameter|DEFCENT]]</var> value to use; it overrides all other <var>DEFCENT</var> and <var>[[CENTSPLT parameter|CENTSPLT]]</var> parameter values. This argument cannot be specified with the <var class="term">centsplt</var> argument, unless one of the values is NULL.</li>
</li>
</li>
<li>The <var class="term">centsplt</var> argument (optional) specifies the CENTSPLIT value to use; it overrides all other <var>DEFCENT</var> and <var>CENTSPLT</var> parameter values. This argument cannot be specified with the <var class="term">defcent</var> argument, unless one of the values is NULL.</li>
</ul>
</ul>
<b>Dates in differing centuries</b>
 
<p>In the following procedure Date_Difference, the $DATEDIF function calculates the difference between dates twice. Before the first PRINT command, the CUSTOM parameter is set to 1, so the century defaults to the current century. Before the second PRINT command, the DEFCENT parameter is set to 20. </p>
====Dates in differing centuries====
<p class="code">
<p>
In the following procedure, <code>Date_Difference</code>, <var>$Datedif</var> calculates the difference between dates twice. Before the first <var>Print</var> statement, the <var>[[CUSTOM parameter|CUSTOM]]</var> parameter is set to 1, so the century defaults to the current century. Before the second <var>Print</var> statement, the <var>DEFCENT</var> parameter is set to 20. </p>
<p class="code">PROCEDURE DATE_DIFFERENCE
RESET CUSTOM=(1)
RESET CUSTOM=(1)
BEGIN
Begin
PRINT $DATEDIF('CYYDDD','96333','YY MM DD','97 06 22',-
Print $Datedif('CYYDDD','96333','YY MM DD','97 06 22',%defcent,%centsplt)    
      %DEFCENT,%CENTSPLT)
%defcent = 20
%DEFCENT = 20
Print $Datedif('CYYDDD','096333','YY MM DD','97 06 22',%defcent,%centsplt)    
PRINT $DATEDIF('CYYDDD','096333','YY MM DD','97 06 22',-
End
      %DEFCENT,%CENTSPLT)
END PROCEDURE
END
</p>
</p>
<p>For an explanation of the DEFCENT and CENTSPLT parameters processing see Rocket <var class="product">Model&nbsp;204</var> Parameter and Command Reference Manual in the chapter on parameters.</p>
 
<b>Separators and leading zeros</b>
====Separators and leading zeros====
<ul>
<ul>
<li>The separators in each format must match the separators in the corresponding date. For example:</li>
<li>The separators in each format must match the separators in the corresponding date. For example:</li>
<p class="code">$DATEDIF('MON DD, YYYY','JAN 08, 1990', -
<p class="code">$datedif('MON DD, YYYY','JAN 08, 1990','YY:DDD', '88:210')        
        'YY:DDD', '88:210')  
</p></li>
</p></li>
<li>When necessary, pad the month or date in the date argument with leading zeros to match the length of corresponding format argument. For example:</li>
<li>When necessary, pad the month or date in the date argument with leading zeros to match the length of corresponding format argument. For example:</li>
<p class="code">$DATEDIF('YY DDD','90 034',,'90 007')   
<p class="code">$datedif('YY DDD','90 034',,'90 007')   
</p></li>
</p></li>
</ul>
</ul>
<b>How $DATEDIF works</b>
 
====How $Datedif works====
<ul>
<ul>
<li>If date1 is the same as date2, 0 is returned.</li>
<li>If date1 is the same as date2, 0 is returned.</li>
Line 92: Line 111:
</li>
</li>
</ul>
</ul>
<b>Example</b>
 
<p class="code">PRINT $DATEDIF('MMDDYY','010790',,'040891')  
====Example====
The following statement:
<p class="code">Print $datedif('MMDDYY','010790',,'040891')  
</p>
</p>
<p>prints this value:</p>
<p>
prints this value:</p>
<p class="code"><b></b>-456   
<p class="code"><b></b>-456   
</p>
</p>
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Revision as of 22:10, 3 April 2014

The $Datedif function returns the difference in days between two dates.

Syntax

The format of the $Datedif function is:

$Datedif(date-1-format, date-1, date-2-format, date-2, defcent, centsplt)

Where:

  • date-1-format specifies the format of the first date. The format can be a combination of these elements:
    DD Gregorian numeric day
    DDD Julian numeric date
    MM Numeric month
    MON Abbreviated month name
    MONTH Full month name
    YY Last two digits of numeric year (assumes that the year prefix is 19)
    YYYY Full numeric year
    CYY The century, plus the year. Century (C) is a single digit, where 0 represents 1900, 1 represents 2000, and so on.

    Valid formats are:

    • A format that has a month, day, and year element
    • A Julian date format that has a year element and a day element in the format DDD

    Any EBCDIC characters except single quotes are allowed within the input format and appear unchanged in the output date. The input format can be as many as 32 characters in length.

  • date-1 specifies the first date in the format specified by the date-1-format argument. The date can be as many as 36 characters in length.
  • date-2-format specifies the format of the second date. The format requirements are the same as those for the date-1-format argument. This argument can be omitted but the comma after it is required. If this argument is omitted, $Datedif assumes that date-2 is in the same format as date-1.
  • date-2 specifies the second date. The date must be either in the format specified in the date-2-format argument, or in the format specified in date-1-format if date-2-format is not specified. The date can be as many as 36 characters in length.
  • The defcent argument (optional) specifies the DEFCENT value to use; it overrides all other DEFCENT and CENTSPLT parameter values. This argument cannot be specified with the centsplt argument, unless one of the values is NULL.
  • The centsplt argument (optional) specifies the CENTSPLIT value to use; it overrides all other DEFCENT and CENTSPLT parameter values. This argument cannot be specified with the defcent argument, unless one of the values is NULL.

Dates in differing centuries

In the following procedure, Date_Difference, $Datedif calculates the difference between dates twice. Before the first Print statement, the CUSTOM parameter is set to 1, so the century defaults to the current century. Before the second Print statement, the DEFCENT parameter is set to 20.

PROCEDURE DATE_DIFFERENCE RESET CUSTOM=(1) Begin Print $Datedif('CYYDDD','96333','YY MM DD','97 06 22',%defcent,%centsplt) %defcent = 20 Print $Datedif('CYYDDD','096333','YY MM DD','97 06 22',%defcent,%centsplt) End END PROCEDURE

Separators and leading zeros

  • The separators in each format must match the separators in the corresponding date. For example:
  • $datedif('MON DD, YYYY','JAN 08, 1990','YY:DDD', '88:210')

  • When necessary, pad the month or date in the date argument with leading zeros to match the length of corresponding format argument. For example:
  • $datedif('YY DDD','90 034',,'90 007')

How $Datedif works

  • If date1 is the same as date2, 0 is returned.
  • If date1 is earlier than date2, a negative integer is returned.
  • If date1 is later than date2, a positive integer is returned.
  • If an error occurs, 999999999 is returned.

Example

The following statement:

Print $datedif('MMDDYY','010790',,'040891')

prints this value:

-456