ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/CDRGCCN.htm

294 lines
8.4 KiB
HTML

<!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 CCSID for Normalization (CDRGCCN, QTQGCCN) 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 CCSID for Normalization (CDRGCCN, QTQGCCN) API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;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%">CCSID1</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">CCSID2</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">CCSIDN</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Int(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">HINTV</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">FB</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Feedback</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>When certain operations, such as concatenation or comparison, are performed
on graphic character strings, the two strings are both in the same CCSID, or
they are normalized first to a single CCSID before concatenation. This function
assists in determining the CCSID for normalization given two CCSIDs. The
returned CCSID may equal one or both the input CCSIDs.</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>CCSID1</strong></dt>
<dd>INPUT; INT(4)
<p>This variable contains the first CCSID value referenced. Possible values are
a positive number in the range 1 to 65,533.</p>
</dd>
<dt><strong>CCSID2</strong></dt>
<dd>INPUT; INT(4)
<p>This variable contains the second CCSID value referenced. Possible values
are a positive number in the range 1 to 65,533.</p>
</dd>
<dt><strong>CCSIDN</strong></dt>
<dd>OUTPUT; INT(4)
<p>This variable contains the returned CCSID value for normalization. Possible
values are a positive number in the range 1 to 65,533.</p>
</dd>
<dt><strong>HINTV</strong></dt>
<dd>OUTPUT; INT(4)
<p>The function returns in this variable a number that conveys information to
assist the calling function in its subsequent processing. The following values
and meanings are defined:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">HINTV</th>
<th align="left" valign="top">Meaning</th>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">No hints</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">CCSID1 and CCSID2 have both the same value for their CP
element. The returned CCSIDN has a character set which is a superset of or
equals the larger of the character sets of CCSID1 and CCSID2.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td valign="top">CCSIDN has the same CP element as CCSID2. The character set of
CCSIDN is a superset of or equals the character set of CCSID2. Only the string
with CCSID1 needs to be converted to CCSIDN.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td valign="top">CCSIDN has the same CP element as CCSID1. The character set of
CCSIDN is a superset of or equals the character set CCSID1. Only the string
with CCSID2 needs to be converted to CCSIDN.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>FB</strong></dt>
<dd>OUTPUT; FEEDBACK
<p>The 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 Hex) 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">There is no entry in the
resource--Normalization Support CCSID Table (NSCT)--for the pair CCSID1,
CCSID2.</td>
</tr>
<tr>
<td align="center" valign="top">0002</td>
<td align="center" valign="top">0001</td>
<td align="left" valign="top">CCSID1 value is 0, which is reserved
to indicate defaulting to a higher level in a hierarchy. The caller must
resolve the default before calling this function.</td>
</tr>
<tr>
<td align="center" valign="top">0002</td>
<td align="center" valign="top">0002</td>
<td align="left" valign="top">CCSID2 value is 0, which is reserved
to indicate defaulting to a higher level in a hierarchy. The caller must
resolve the default before calling this function.</td>
</tr>
<tr>
<td align="center" valign="top">0003</td>
<td align="center" valign="top">0001</td>
<td align="left" valign="top">CCSID1 is 65,535.</td>
</tr>
<tr>
<td align="center" valign="top">0003</td>
<td align="center" valign="top">0002</td>
<td align="left" valign="top">CCSID2 is 65,535.</td>
</tr>
<tr>
<td align="center" valign="top">0006</td>
<td align="center" valign="top">0001</td>
<td align="left" valign="top">The NSCT resource 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 NSCT resource 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 NSCT resource accessed by
the function is 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">CCSID1 value 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">CCSID2 value is not in the range 0 to
65,535.</td>
</tr>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<ol>
<li>The values returned by this function are implementation specific and may
vary from system to system.</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>