<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation"> <title>Get Short Form (CCSID) from Specified ES and (CS, CP) Pair (CDRSCSP, QTQSCSP) API</title> <!-- Begin Header Records ========================================== --> <!-- All rights reserved. Licensed Materials Property of IBM --> <!-- US Government Users Restricted Rights --> <!-- Use, duplication or disclosure restricted by --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <!-- Change History: --> <!-- YYMMDD USERID Change description --> <!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at --> <!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 --> <!--File Edited December 2001 --> <!-- End Header Records --> <link rel="stylesheet" type="text/css" href="../rzahg/ic.css"> </head> <body> <!-- Java sync-link --> <script language="Javascript" src="../rzahg/synch.js" type="text/javascript"> </script> <a name="top_Of_Page"></a> <h2>Get Short Form (CCSID) from Specified ES and (CS, CP) Pair (CDRSCSP, QTQSCSP) API</h2> <div class="box" style="width: 60%;"> <br> Required Parameter Group:<br> <!-- iddvc RMBR --> <br> <table width="100%"> <tr> <td align="center" valign="top" width="10%">1</td> <td align="left" valign="top" width="40%">CSCPL</td> <td align="left" valign="top" width="25%">Input</td> <td align="left" valign="top" width="25%">Int(4)</td> </tr> <tr> <td align="center" valign="top">2</td> <td align="left" valign="top">N1</td> <td align="left" valign="top">Input</td> <td align="left" valign="top">Int(4)</td> </tr> <tr> <td align="center" valign="top">3</td> <td align="left" valign="top">ESIN</td> <td align="left" valign="top">Input</td> <td align="left" valign="top">Int(4)</td> </tr> <tr> <td align="center" valign="top">4</td> <td align="left" valign="top">CCSIDR</td> <td align="left" valign="top">Output</td> <td align="left" valign="top">Int(4)</td> </tr> <tr> <td align="center" valign="top">5</td> <td align="left" valign="top">ESR</td> <td align="left" valign="top">Output</td> <td align="left" valign="top">Int(4)</td> </tr> <tr> <td align="center" valign="top">6</td> <td align="left" valign="top">FB</td> <td align="left" valign="top">Output</td> <td align="left" valign="top">Feedback</td> </tr> </table> <br> Default Public Authority: *USE<br> <!-- iddvc RMBR --> <br> Threadsafe: No<br> <!-- iddvc RMBR --> <br> </div> <p>The Get Short Form (CCSID) from Specified ES and (CS, CP) Pair (CDRSCSP, QTQSCSP) API gets the CCSID associated with the specified (CS, CP) pairs and ES. It aids in coexistence and migration for products that have to deal with the short form (CCSID) of identification on one side and the intermediate form (CGCSGID) on the other. The ES is further required to distinguish between usage of the same CS, CP with two different encoding schemes, (such as CS 00697 and CP 00850, with ES values of X'2100' and X'3100'), and when more than one CGCSGID is associated with a CCSID (such as with ES X'1301', X'2300', and X'3300')</p> <!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. --> <!-- Instead, use the commented out coding below to indicate NONE. --> <h3>Authorities and Locks</h3> <!-- Use this if there are no authorities and locks. --> <p>None.</p> <br> <h3>Required Parameter Group</h3> <dl> <dt><strong>CSCPL</strong></dt> <dd>INPUT; INT(4) <p>This variable is an array whose format is CS1, CP1, CS2, CP2,...CSn, CPn. Each CS is a positive number in the range 1 to 65,535. Each CP is a positive number in the range 1 to 65,534. Each CP is placed in a single CSCPL array element.</p> </dd> <dt><strong>N1</strong></dt> <dd>INPUT; INT(4) <p>This variable contains the number of elements in CSCPL, an even positive number in the range 2 to 32 (can accommodate up to 16 CS and CP pairs.)</p> </dd> <dt><strong>ESIN</strong></dt> <dd>INPUT; INT(4) <p>This variable contains the ES value referenced, zero or a positive number in the range 4352 to 65,534. The implementation of this API supports only a value of 0 for this parameter.</p> <table cellpadding="3"> <!-- cols="10 90" --> <tr> <th align="left" valign="top">ESIN</th> <th align="left" valign="top">Meaning</th> </tr> <tr> <td align="left" valign="top"><em>0</em></td> <td valign="top">The caller does not know the ESID value. The CCSID returned is the first occurring in the CCSID resource repository whose CS and CP values match those specified in CSCPL.</td> </tr> </table> <br> </dd> <dt><strong>CCSIDR</strong></dt> <dd>OUTPUT; INT(4) <p>This variable contains the returned CCSID value, a positive number in the range 1 to 65,534. A value of 65,535 is returned when the function could not find the requested CCSID.</p> </dd> <dt><strong>ESR</strong></dt> <dd>OUTPUT; INT(4) <p>This variable contains the ES value of the returned CCSID, a zero, or a positive number in the range 4352 to 65,534. The implementation of this API does not support the function of this parameter.</p> </dd> <dt><strong>FB</strong></dt> <dd>OUTPUT; FEEDBACK <p>This function returns (in this feedback array) the processing status (and any associated reason) for this function the field-type is array of three 32-bit two's complement binary values (12 bytes, or 96 bits); the status code is a non-negative number in the first 16 bits, and the reason code is a non- negative number in the second 16 bits. The following are specific meanings of the status code and associated reason code values (in hexadecimal) contained in the first 32 bits of FB.</p> </dd> </dl> <br> <h3>Feedback Codes and Conditions</h3> <table border width="80%"> <tr> <th align="center" valign="top">Status</th> <th align="center" valign="top">Reason</th> <th align="left" valign="top">Meaning</th> </tr> <tr> <td align="center" valign="top" width="10%">0000</td> <td align="center" valign="top" width="10%">0000</td> <td align="left" valign="top" width="80%">The function completed successfully.</td> </tr> <tr> <td align="center" valign="top">0001</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">No entry was found in the CCSID resource repository for the specified ESIN and CS, CP pairs.</td> </tr> <tr> <td align="center" valign="top">0001</td> <td align="center" valign="top">0002</td> <td align="left" valign="top">A single CCSID value with the specified CSCPL was found, but not with the specified ESIN. The values of CCSID found and its associated ES are returned.</td> </tr> <tr> <td align="center" valign="top">0002</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">A CP value in CSCPL is zero.</td> </tr> <tr> <td align="center" valign="top">0002</td> <td align="center" valign="top">0002</td> <td align="left" valign="top">A CS value in CSCPL is zero.</td> </tr> <tr> <td align="center" valign="top">0003</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">A CP value in CSCPL is 65,535.</td> </tr> <tr> <td align="center" valign="top">0005</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">N1 is odd.</td> </tr> <tr> <td align="center" valign="top">0006</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">The CCSID resource repository was not found.</td> </tr> <tr> <td align="center" valign="top">0006</td> <td align="center" valign="top">0002</td> <td align="left" valign="top">The CCSID resource repository is currently unavailable.</td> </tr> <tr> <td align="center" valign="top">0007</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">The system CCSID resource repository accessed by the function was found to be invalid in structure.</td> </tr> <tr> <td align="center" valign="top">0008</td> <td align="center" valign="top">0001</td> <td align="left" valign="top">A CS or CP value in CSCPL array is not in the range 0 to 65,535.</td> </tr> <tr> <td align="center" valign="top">0008</td> <td align="center" valign="top">0002</td> <td align="left" valign="top">N1 is greater than the maximum permitted in this implementation.</td> </tr> <tr> <td align="center" valign="top">0008</td> <td align="center" valign="top">0003</td> <td align="left" valign="top">N1 is less than 2.</td> </tr> <tr> <td align="center" valign="top">0008</td> <td align="center" valign="top">0004</td> <td align="left" valign="top">ESIN value is nonzero and not in the range 4352 to 65,534.</td> </tr> </table> <br> <br> <h3>Usage Notes</h3> <ol> <li>Often it is required to find the CCSID when the ES and (CS,CP) values are known. CS, CP (also known as CGCSGID or GCID) is used in many existing IBM<SUP>(TM)</SUP> architectures, data streams, and supporting products. This function aids in coexistence and migration for products that have to deal with the short form (CCSID) of identification on one side and the intermediate form (CGCSGID) on the other. Intermediate forms are by themselves incomplete, that is, without an encoding scheme a single CCSID cannot be identified in all cases. The function can return only a default value as defined in the installation's resources when the ESIN information is not known.<br> <br> </li> <li>For the CCSIDs defined to date, the maximum number of CS, CP pairs is 2 (up to four values can be specified in CSCPL). There may be additional CCSIDs which meet the specified criteria.</li> </ol> <hr> API introduced: V2R2 <hr> <center> <table cellpadding="2" cellspacing="2"> <tr align="center"> <td valign="middle" align="center"><a href="#top_Of_Page">top</a> | <a href= "nls1.htm">National Language Support APIs</a> | <a href="aplist.htm">APIs by category</a></td> </tr> </table> </center> </body> </html>