Parameters [ Compiler Library/XL Reference Manual ] MPE/iX 5.0 Documentation
Compiler Library/XL Reference Manual
Parameters
The following section lists and describes the parameters used by the
packed-decimal library procedures.
operand2 Typically, the operand that receives the result of
the operation. The exception is HPPACCMPD, which
does not change either operand.
op2digs The length of operand2 in digits.
operand1 The other operand. As shown in the calling
sequences, operand2 is given before operand1, except
in the case of HPPACCMPD.
op1digs The length of operand1 in digits.
source The sending field in a conversion to or from
external-decimal or binary.
sourcedigs The length of the source field in digits.
sourcewords The length of the source field in 16-bit "words."
target The receiving field in a conversion.
targetdigs The length of the target field in digits.
comparison_code an integer to which the procedure will always return
a value of 0, 1, or 2.
NOTE Comparison_code corresponds to the condition code of the status
register on HP 3000 Series V systems.
The value returned is not meaningful when an operand length of zero
is specified, or when an error is detected. If a result is
truncated because the target digit count is too small,
comparison_code is set in accordance with the truncated result.
All the procedures except HPPACCMPD set comparison_code as follows:.
comparison_code = 0 if result > 0
= 1 if result < 0
= 2 if result = 0
HPPACCMPD sets comparison_code as follows:
comparison_code = 0 if operand1 > operand2
= 1 if operand1 < operand2
= 2 if operand1 = operand2
pacstatus An integer to which the procedure will always return an
indication of the success or failure of the operation.
When no error is detected, pacstatus is set to 0. When
an error is detected, pacstatus is set to a code
indicating the type of error that occurred. By default,
detection of an error will result in the process being
aborted with a 3000-mode packed-decimal trap.
Therefore, a program will normally examine this
parameter only in cases where default trap-handling is
not in effect.
The state of pacstatus (zero or nonzero) corresponds to
the overflow bit of the status register on HP 3000
Series V systems.
The following values are possible for this parameter:
0 No error
1 Decimal overflow
2 Invalid ASCII digit
3 Invalid packed-decimal digit
4 Invalid source word count
5 Invalid decimal operand length
6 Decimal divide-by-zero
carry An integer to which the procedure will always return a
value of 0 or 1. This value corresponds to the carry
bit of the status register on HP 3000 Series/V systems.
sign_control For HPPACCVDA, a parameter that controls the sign of the
result when the source field is signed.
shift_amt For the shift operations, the number of digits to be
shifted left or right. For HPPACNSLD, this parameter is
passed by reference; for the other shift operations, it
is passed by value.
NOTE The packed-decimal procedures do not alter the condition code
associated with the process.
MPE/iX 5.0 Documentation