PI11295: USUPPLEMENTARY FUNCTION RETURNS UNEXPECTED RESULTS FOR NATIONAL CHARACTERS & LANGUAGE REFERENCE GUIDE HAS A USUPPLEMENTARY TYPO

Obtain the fix for this APAR.

APAR status

• Closed as program error.

Error description

• Ø
  There is a documentation typo and a runtime output error for
  the USUPPLEMENTARY function.
  
  Doc Error:
  
  The doc error is in the Enterprise Cobol for z/OS 5.1 Language
  Reference Guide at
  http://pic.dhe.ibm.com/infocenter/pdthelp/v1r1/topic/com.ibm.ent
  cobol.doc_5.1/PGandLR/ref/rlinfusup.html .
  
  You can't define the value below as it is listed in the doc.
  01 N pic N(3) value nx'00200020D834DD1E'.  <== Note the N(3)
  
  If you do, you get this error at compile time:
  IGYGR1056-E "VALUE" literal "NX"00200020D834DD1E"" exceeded the
  length specified in the "PICTURE" definition. The literal was
  truncated to the "PICTURE" definition length.
  
  It should be defined as:
  01 N pic N(4) value nx'00200020D834DD1E'.  <== Note the N(4)
  
  
  Runtime Error:
  
  When using national characters, the USUPPLEMENTARY function
  returns unexpected results.
  
  On LABW, see the following test case:
  
  CBLSERV.PMR.P43143.B499.C000.TESTCASE     < Test JCL
  CBLSERV.PMR.P43143.B499.C000.LOADLIB      < Load Module
  CBLSERV.PMR.P43143.B499.C000.RUN.OUTPUT   < Output from program
  run
  
  At the bottom of the output, you will see 3 test cases.  Test
  case 6 is okay, but test case 7 & 8 appear to result in
  incorrect output from the USUPPLEMENTARY function.
  
  *************************************************
  TEST 6 VALIDITY = 00
  01  NATIONAL-B PICTURE N(2) VALUE NX"D834DD1E".
  COMPUTE L1 = FUNCTION USUPPLEMENTARY(NATIONAL-B)
  TEST 6 PASS, L1=01
  @kayinlam@ca.ibm.com
  *************************************************
  TEST 7 VALIDITY = 00
  01  NATIONAL-C PICTURE N(3) VALUE NX"0020D834DD1E".
  COMPUTE L1 = FUNCTION USUPPLEMENTARY(NATIONAL-C)
  TEST 7 FAIL: SHOULD EQUAL 02 BUT L1=01
  *************************************************
  TEST 8 VALIDITY = 00
  01  NATIONAL-D PICTURE N(4)
                 VALUE NX"00200020D834DD1E".
  COMPUTE L1 = FUNCTION USUPPLEMENTARY(NATIONAL-D)
  TEST 8 FAIL: SHOULD EQUAL 03 BUT L1=02
  *************************************************
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED: User of UTF-16 who uses USUPPLEMENTARY       *
  *                 function.                                    *
  ****************************************************************
  * PROBLEM DESCRIPTION: The USUPPLEMENTARY function returns     *
  *                      incorrect results for UTF-16 data,      *
  *                      when it contains a supplementary        *
  *                      character.                              *
  ****************************************************************
  * RECOMMENDATION:                                              *
  ****************************************************************
  

Problem conclusion

• Apply provided service
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Modules/Macros

• IGZXLPKA
  

Fix information

• Fixed component name

  LE ENT COBOL LI

• Fixed component ID

  568819812

Applicable component levels

• R780 PSY UI15839

     UP14/03/21 P F403

• R790 PSY UI15840

     UP14/03/21 P F403

Fix is available

• Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.