Built-in number for LBEDIT is 137.
LBEDIT (
        receiver            : address
        receiver_length     : address of unsigned binary(4)
        source              : address of signed binary(4) OR
                              address of unsigned binary(4) OR
                              address of packed decimal (1 to 63 digits) OR
                              address of zoned decimal (1 to 63 digits)
        source_attributes   : address
        mask                : address
        mask_length         : address of unsigned binary(4)
)

The receiver, source and mask parameters correspond to operands 1, 2 and 3 on the EDIT operation.

The source_attributes is a structure which describes the data attributes of the source value. The format of this structure matches that of the third operand on the CVTCN and CVTNC operations.

The receiver_length and mask_length parameters contain the length, in bytes, of the receiver and mask. They are expected to contain a value between 1 and 256.

 
  -- OR -- 
 
EDITPD (
        receiver          : address
        receiver_length   : unsigned binary(4)
        source            : address of packed decimal (1 to 63 digits)
        source_length     : unsigned binary(4)
        mask              : address
        mask_length       : unsigned binary(4)
)

This built-in function supports the EDIT operation when the source contains a packed decimal value. The receiver, source and mask parameters correspond to operands 1, 2 and 3 on the EDIT operation.

The source_length parameter contains the length, in digits, of the source. It is expected to contain a value between 1 and 63.

The receiver_length and mask_length parameters contain the length, in bytes, of the receiver and mask. They are expected to contain a value between 1 and 256.

Hex AF

This control character indicates the start of a static field. A static field is used to indicate that one of two mask character strings immediately following this character is to be inserted into the result field, depending upon the algebraic sign of the source field. If the sign is positive, the first string is to be inserted into the result field; if the sign is negative, the second string is to be inserted.

Static field format:

<Hex AF> <positive string>. . .<less than hex 40> <negative string>. . .<hex AE>

OR

<Hex AF> <positive string>. . .<hex AE> <negative string>. . .<hex AE>

Hex B1

This control character indicates the start of a floating string specification field. The first character of the field is used as the fill character; following the fill character are two strings delimited by the end-of-string control character. If the algebraic sign of the source field is positive, the first string is to be overlaid into the result field; if the sign is negative, the second string is to be overlaid.

The string selected to be overlaid into the result field, called a floating string, appears immediately to the left of the first significant result character. If significance is never set, neither string is placed in the result field.

Conditional source digit positions (hex B2 control characters) must be provided in the edit mask immediately following the hex B1 field to accommodate the longer of the two floating strings; otherwise, a length conformance  (hex 0C08) exception is signaled. For each of these B2 strings, the fill character is inserted into the result field, and source digits are not consumed. This ensures that the floating string never overlays bytes preceding the receiver operand.

Floating string specification field format:

<Hex B1> <fill character> <positive string>. . . <end-of-string character> <negative string>. . .<end-of-string character>

followed by

<Hex B2>. . .

Hex B0

This control character indicates the start of a conditional string, which consists of any characters delimited by the end-of-string control character. Depending on the state of the significance indicator, this string or fill characters replacing it is inserted into the result field. If the significance indicator is off, a fill character for every character in the conditional string is placed in the result field. If the indicator is on, the characters in the conditional string are placed in the result field.

Conditional string format:

<Hex B0> <conditional string>. . .<end-of-string character>

Hex B3

This control character turns on the significance indicator and indicates the start of an unconditional string that consists of any characters delimited by the end-of-string control character. This string is unconditionally inserted into the result field regardless of the state of the significance indicator. If the indicator is off when a B3 control character is encountered, the appropriate floating string is overlaid into the result field before (to the left of) the B3 unconditional string (or to the left of where the unconditional string would have been if it were not null).

Unconditional string format:

<Hex B3> <unconditional string>. . .<end-of-string character>

Hex B2

This control character specifies that either the corresponding source field digit or the floating string (hex B1) fill character is inserted into the result field, depending on the state of the significance indicator. If the significance indicator is off, the fill character is placed in the result field; if the indicator is on, the source digit is placed. When a source digit is moved to the result field, the zone supplied is hex F. When significance (that is, a nonzero source digit) is detected, the floating string is overlaid to the left of the first significant character.

Hex AA

This control character specifies that the corresponding source field digit is unconditionally placed in the 4 low-order bits of the result field with the zone set to a hex F.

Hex AB

This control character specifies that the corresponding source field digit is unconditionally placed in the result field. If the sign of the source field is positive, the zoned portion of the digit is set to hex F (the preferred positive sign); if the sign is negative, the zone portion is set to hex D (the preferred negative sign).

Hex AC

This control character specifies that the corresponding source field digit is unconditionally placed in the result field. If the algebraic sign of the source field is positive, the zone portion of the result is set to hex F (the preferred positive sign); otherwise, the source sign field is moved to the result zone field.

Hex AD

This control character specifies that the corresponding source field digit is unconditionally placed in the result field. If the algebraic sign of the source field is negative, the zone is set to hex D (the preferred negative sign); otherwise, the source field sign is moved to the zone position of the result byte.

1. Any character is a valid fill character, including the end-of-string character.
2. Hex AF, hex B1, hex B0, and hex B3 strings must be terminated by the end-of-string character even if they are null strings.
3. If a hex B1 field has not been encountered (specified) when the significance indicator is turned on, the floating string is considered to be a null string and is therefore not used to overlay into the result field.
4. If the positive and negative strings of a static field are of unequal length, additional static fields are necessary to ensure that the sum of the lengths of the positive strings equal the sum of the lengths of the negative strings; otherwise, a length conformance  (hex 0C08) exception is signaled because the receiver length does not correspond to the length implied by the edit mask and source field sign.