$DateCnv - Revision history

JAL: add link

2015-10-06T21:24:04Z

add link

← Older revision		Revision as of 21:24, 6 October 2015
Line 93:		Line 93:

	==Examples==		==Examples==
			In addition to the following examples, see also [[Overview of $Date functions#Examples\|these examples]].
	<ol>		<ol>
	<li><p class="code">Print $DateCnv('DDMMYY','MON DD, YYYY','010790')		<li><p class="code">Print $DateCnv('DDMMYY','MON DD, YYYY','010790')

JAL: misc cleanup

2015-09-23T22:07:07Z

misc cleanup

← Older revision		Revision as of 22:07, 23 September 2015
Line 1:		Line 1:
	<p>		<p>
	The <var>$~~DATECNV~~</var> function converts an input date from its current format to a format you specify and, also, determines whether the input date is valid. If a format error occurs or the input date is not valid, the function returns all asterisks (*). <var>$~~DATECNV~~</var> supports both a 2- and a 4-digit year format; the year prefix can come from one of four places.</p>		The <var>$DateCnv</var> function converts an input date from its current format to a format you specify and, also, determines whether the input date is valid. If a format error occurs or the input date is not valid, the function returns all asterisks (*). <var>$$DateCnv</var> supports both a 2- and a 4-digit year format; the year prefix can come from one of four places.</p>

	==Syntax==		==Syntax==
	<p>		<p>
	The format of the <var>$~~DATECNV~~</var> function is:</p>		The format of the <var>$DateCnv</var> function is:</p>
	<p class="syntax">$~~DATECNV~~(<span class="term">input format</span>, <span class="term">output format</span>, <span class="term">input date</span>, <span class="term">defcent</span>, <span class="term">centsplt</span>)		<p class="syntax">$DateCnv(<span class="term">input-format</span>, <span class="term">output-format</span>, <span class="term">input-date</span>, [<span class="term">defcent</span>], [<span class="term">centsplt</span>])
	</p>		</p>
	<p>		<p>
	Where:</p>		Where:</p>
	<ul>		<ul>
	<li><var class="term">input format</var> specifies the format of the input date. The format can be a combination of these elements:		<li><var class="term">input-format</var> specifies the format of the input date. The format can be a combination of these elements:
	<table class="thJustBold">		<table class="thJustBold">
	<tr>		<tr>
Line 49:		Line 49:
	<tr>		<tr>
	<th>CYY</th>		<th>CYY</th>
	<td>The century, plus the year. Century (C) is a single digit, where 0 represents 1900, 1 represents 2000, and so on.</td>		<td>The century, plus the year. Century (<var>C</var>) is a single digit, where 0 represents 1900, 1 represents 2000, and so on.</td>
	</tr>		</tr>
	</table>		</table>
Line 61:		Line 61:
	When you use a 2-digit year, for example, <var>YY</var> is 98) in the input format and a 4-digit year (<var>YYYY</var>) in the output format, <var class="product">Model 204</var> assumes that the century is 19-, for example, 1998.</p>		When you use a 2-digit year, for example, <var>YY</var> is 98) in the input format and a 4-digit year (<var>YYYY</var>) in the output format, <var class="product">Model 204</var> assumes that the century is 19-, for example, 1998.</p>

	<li><var class="term">output format</var> specifies the format of the output date. The format requirements are the same as those for the input format argument. Using a 2-digit year (<var>YY</var>) in the output format leaves you with no way to distinguish between centuries. For example:		<li><var class="term">output-format</var> specifies the format of the output date. The format requirements are the same as those for the <var class="term">input-format</var> argument. Using a 2-digit year (<var>YY</var>) in the output format leaves you with no way to distinguish between centuries. For example:
	<p class="code">$~~DATECNV~~('MON DD, YYYY', 'YY DDD', 'JAN 10, 2005')		<p class="code">$DateCnv('MON DD, YYYY', 'YY DDD', 'JAN 10, 2005')
	</p>		</p>
	<p>		<p>
	produces the following output:</p>		produces the following output:</p>
	<p class="~~code~~">05 010		<p class="output">05 010
	</p>		</p>
	<p>		<p>
Line 72:		Line 72:
	</li>		</li>

	<li><var class="term">input date</var> specifies the input date in the format indicated by the input format argument. The input date can be as many as 36 characters in length.</li>		<li><var class="term">input-date</var> specifies the input date in the format indicated by the <var class="term">input-format</var> argument. The input date can be as many as 36 characters in length.</li>

	<li><var class="term">defcent</var> (optional) specifies the <var>[[DEFCENT parameter\|DEFCENT]]</var> 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">centsplt</var> argument, unless one of the values is NULL. </li>		<li><var class="term">defcent</var> (optional) specifies the <var>[[DEFCENT parameter\|DEFCENT]]</var> 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">centsplt</var> argument, unless one of the values is NULL. </li>
Line 83:		Line 83:
	Use separators and leading zeros as specified here:</p>		Use separators and leading zeros as specified here:</p>
	<ul>		<ul>
	<li>Separators in the input format argument must match the separators in the input date argument. For example:		<li>Separators in the <var class="term">input-format</var> argument must match the separators in the <var class="term">input-date</var> argument. For example:
	<p class="code">$~~DATECNV~~('MONTH - DD - YYYY','MON DD, YYYY', 'JANUARY - 05 - 1990')		<p class="code">$DateCnv('MONTH - DD - YYYY','MON DD, YYYY', 'JANUARY - 05 - 1990')
	</p></li>		</p></li>

	<li>When necessary, you must pad the month or date in the input date argument with leading zeros to match the length of input format. For example:~~</li>~~		<li>When necessary, you must pad the month or date in the input date argument with leading zeros to match the length of <var class="term">input-format</var>. For example:
	<p class="code">$~~DATECNV~~('YY DDD','MON DD, YYYY','90 023')		<p class="code">$DateCnv('YY DDD','MON DD, YYYY','90 023')
	</p></li>		</p></li>
	</ul>		</ul>
Line 94:		Line 94:
	==Examples==		==Examples==
	<ol>		<ol>
	<li><p class="code">~~PRINT~~ $~~DATECNV~~('DDMMYY','MON DD, YYYY','010790')		<li><p class="code">Print $DateCnv('DDMMYY','MON DD, YYYY','010790')
	</p>		</p>
	<p>		<p>
	prints this value:</p>		prints this value:</p>
	<p class="~~code~~">JUL 01, 1990		<p class="output">JUL 01, 1990
	</p></li>		</p></li>

	<li><p>		<li><p>
	The following example shows <var>$~~DATECNV~~</var> converting dates in various centuries.</p>		The following example shows <var>$DateCnv</var> converting dates in various centuries.</p>
	<p class="code">PROCEDURE CENTSPLT		<p class="code">PROCEDURE CENTSPLT
	BEGIN		BEGIN

Mlarocca: Mlarocca moved page $DATECNV to $DateCnv: Lower case change

2014-07-17T13:01:20Z

Mlarocca moved page $DATECNV to $DateCnv: Lower case change

← Older revision	Revision as of 13:01, 17 July 2014
(No difference)

JAL at 20:01, 14 April 2014

2014-04-14T20:01:19Z

Show changes

JAL: minor cleanup

2014-04-14T18:58:01Z

minor cleanup

Show changes

Alex: Automatically generated page update

2013-04-20T13:18:45Z

Automatically generated page update

New page

The $DATECNV function converts an input date from its current format to a format you specify and, also, determines whether the input date is valid. If a format error occurs or the input date is not valid, the function returns all asterisks (*). $DATECNV supports both a 2- and a 4-digit year format; the year prefix can come from one of four places.
Syntax
The format of the $DATECNV function is:
$DATECNV(input format,output format,input date,

defcent, centsplt)

where:
<ul>
<li>input format specifies the format of the input date. The format can be a combination of these elements:</li>
<table>
<tr>
<td>DD</td>
<td>Gregorian numeric day</td>
</tr>
<tr>
<td>DDD</td>
<td>Julian numeric date</td>
</tr>
<tr>
<td>MM</td>
<td>Numeric month</td>
</tr>
<tr>
<td>MON</td>
<td>Abbreviated month name</td>
</tr>
<tr>
<td>MONTH</td>
<td>Full month name</td>
</tr>
<tr>
<td>YY</td>
<td>Last two digits of numeric year (assumes that the year prefix is 19)</td>
</tr>
<tr>
<td>YYYY</td>
<td>Full numeric year </td>
</tr>
<tr>
<td>CYY</td>
<td>The century, plus the year. Century (C) is a single digit, where 0 represents 1900, 1 represents 2000, and so on.</td>
</tr>
</table>
Valid formats are:
</li>
</ul>
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. 
When you use a 2-digit year, for example, YY is 98) in the input format and a 4-digit year (YYYY) in the output format, <var class="product">Model 204</var> assumes that the century is 19-, for example, 1998.
<ul>
<li>output format specifies the format of the output date. The format requirements are the same as those for the input format argument. Using a 2-digit year (YY) in the output format leaves you with no way to distinguish between centuries. For example:</li>
$DATECNV('MON DD, YYYY', 'YY DDD', 'JAN 10, 2005')

produces the following output:
05 010

However, the output is exactly the same if the input date is January 10, 1905 or January 10, 2105.
</li>
<li>input date specifies the input date in the format indicated by the input format argument. The input date can be as many as 36 characters in length.</li>
</li>
<li>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>
<li>centsplt argument (optional) specifies the CENTSPLT 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>
</ul>
The following example illustrates the use of the $DATECNV converting dates in various centuries.
PROCEDURE CENTSPLT
BEGIN
%INPUT_FORMAT = 'YYDDD'
%OUTPUT_FORMAT = 'YYYY MM DD'
%INPUT_VALUE = '9633'
%CENTSPLT = 97
%DEFCENT = ' '
CALL PIT
%CENTSPLT = ' '
%DEFCENT = 19
CALL PIT
%INPUT_FORMAT = 'YYYYDDD'
%INPUT_VALUE = '2006333'
CALL PIT
PIT: SUBROUTINE
PRINT %INPUT_FORMAT ' ' %OUTPUT_FORMAT ' ' %INPUT_VALUE -
' ' %DEFCENT ' ' %CENTSPLT
PRINT $DATECNV(%INPUT_FORMAT, %OUTPUT_FORMAT,%INPUT_VALUE, -
%DEFCENT, %CENTSPLT)
RETURN
END SUBROUTINE
END
END PROCEDURE

For an explanation of the DEFCENT and CENTSPLT parameters processing see Rocket <var class="product">Model 204</var> Parameter and Command Reference Manual in the chapter on parameters.
Separators and leading zeros
Use separators and leading zeros as specified here:
<ul>
<li>Separators in the input format argument must match the separators in the input date argument. For example:</li>
$DATECNV('MONTH - DD - YYYY','MON DD, YYYY', -
'JANUARY - 05 - 1990')
</li>
<li>When necessary, you must pad the month or date in the input date argument with leading zeros to match the length of input format. For example:</li>
$DATECNV('YY DDD','MON DD, YYYY','90 023')
</li>
</ul>
Example
PRINT $DATECNV('DDMMYY','MON DD, YYYY','010790')

prints this value:
JUL 01, 1990

[[Category:SOUL $functions]]