$Pack - Revision history

Mlarocca: Mlarocca moved page $PACK to $Pack: Lower case change

2014-07-29T14:06:56Z

Mlarocca moved page $PACK to $Pack: Lower case change

← Older revision	Revision as of 14:06, 29 July 2014
(No difference)

ELowell at 19:28, 13 August 2013

2013-08-13T19:28:44Z

← Older revision		Revision as of 19:28, 13 August 2013
Line 2:		Line 2:
	<b>Syntax</b>		<b>Syntax</b>
	<p>The format for the $PACK function is:</p>		<p>The format for the $PACK function is:</p>
	<p class="~~code~~">$PACK(value,precision <var>[</var>,scale<var>] [</var>,'UNSIGNED'<var>] </var>)		<p class="syntax">$PACK(<span class="term">value,precision</span> <var>[</var>,<span class="term">scale</span><var>] [</var>,'UNSIGNED'<var>] </var>)
	</p>		</p>
	<p>where:</p>		<p>where:</p>
	<ul>		<ul>
	<li>value is a character string that can be a field name, a %variable, or any type of string expression.</li>		<li><var class="term">value</var> is a character string that can be a field name, a %variable, or any type of string expression.</li>
	</li>		</li>
	<li>precision is the number of digits required in the number to be returned. The valid range is between 1 to 16. The precision argument is required.</li>		<li><var class="term">precision</var> is the number of digits required in the number to be returned. The valid range is between 1 to 16. The precision argument is required.</li>
	</li>		</li>
	<li>scale specifies the number of digits to be returned to the right of the decimal point. The scale argument is optional. If the scale argument is omitted, the returned result is an integer.</li>		<li><var class="term">scale</var> specifies the number of digits to be returned to the right of the decimal point. The scale argument is optional. If the scale argument is omitted, the returned result is an integer.</li>
	</li>		</li>
	<li>UNSIGNED specifies that the packed decimal data has a sign code of X'F' regardless of the sign of the data value. The UNSIGNED argument is optional. If the UNSIGNED argument is omitted, the data contains the appropriate code for the sign of the data value. </li>		<li>UNSIGNED specifies that the packed decimal data has a sign code of X'F' regardless of the sign of the data value. The UNSIGNED argument is optional. If the UNSIGNED argument is omitted, the data contains the appropriate code for the sign of the data value. </li>

Alex: Automatically generated page update

2013-04-20T13:19:20Z

Automatically generated page update

New page

The $PACK function returns the packed decimal representation of the character string. 
Syntax
The format for the $PACK function is:
$PACK(value,precision <var>[</var>,scale<var>] [</var>,'UNSIGNED'<var>] </var>)

where:
<ul>
<li>value is a character string that can be a field name, a %variable, or any type of string expression.</li>
</li>
<li>precision is the number of digits required in the number to be returned. The valid range is between 1 to 16. The precision argument is required.</li>
</li>
<li>scale specifies the number of digits to be returned to the right of the decimal point. The scale argument is optional. If the scale argument is omitted, the returned result is an integer.</li>
</li>
<li>UNSIGNED specifies that the packed decimal data has a sign code of X'F' regardless of the sign of the data value. The UNSIGNED argument is optional. If the UNSIGNED argument is omitted, the data contains the appropriate code for the sign of the data value. </li>
</li>
</ul>
Usage
$PACK can be used as an item in an assignment to a %variable that is written to a sequential USE data set.
$PACK should not be used as an operand in an arithmetic expression, because the value returned cannot be correctly interpreted as a number.
<var class="product">Model 204</var> pads the result with leading integer or trailing fractional zeros as appropriate. If the value string is too long for the precision, or if the value is nonnumeric, $PACK returns binary ones. 
<var class="product">Model 204</var> interprets the value returned by $PACK as a character string.
If the precision argument is omitted or if the value is outside the valid range, the following message is issued:
M204.2139: $PACK PRECISION MUST BE IN RANGE 1-16

Example
If you specify these statements:
%X = '123.4'
%A = $PACK(%X,8,3,'UNSIGNED')

the result in %A would be X'0123400F'. When you use the UNSIGNED argument, the result would be identical if %X were assigned a value of -123, because $PACK operates on the absolute value of the number supplied. 
[[Category:SOUL $functions]]