310 lines
8.8 KiB
HTML
310 lines
8.8 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 Encoding Scheme, Character Set, and Code Page Elements (CDRGESP, QTQGESP)
|
||
|
|
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 Encoding Scheme, Character Set, and Code Page Elements (CDRGESP, QTQGESP)
|
||
|
|
API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 65%;">
|
||
|
|
<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%">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">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">N2</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Int(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">ES</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">CSCPL</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Array of 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: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The most frequently accessed elements of a CCSID are the Encoding Scheme and
|
||
|
|
the CS/CP elements. The function returns the value of the encoding scheme (ES)
|
||
|
|
associated with CCSID1 in ES, and the values of CS and CP elements in
|
||
|
|
CSCPL.</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 CCSID value referenced; a positive number in the
|
||
|
|
range 1 to 65,533.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>N1</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; INT(4)
|
||
|
|
|
||
|
|
<p>This variable contains the size of the allocated area starting at CSCPL to
|
||
|
|
contain the returned data. N1 is specified as a number of elements, each CS/CP
|
||
|
|
pair is counted as 2 elements. It is an even number greater than or equal to
|
||
|
|
2.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>N2</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; INT(4)
|
||
|
|
|
||
|
|
<p>This variable contains the number of values (each pair of CS and CP is
|
||
|
|
counted as two values) associated with CCSID1 and returned in CSCPL providing
|
||
|
|
that sufficient space (N1) was allocated. The first invocation of this function
|
||
|
|
must have N2 initialized to zero.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>ES</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; INT(4)
|
||
|
|
|
||
|
|
<p>This variable contains the ES value associated with CCSID1. It is a positive
|
||
|
|
number in the range 4352 to 65,534.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>CSCPL</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; Array of INT(4)
|
||
|
|
|
||
|
|
<p>Start of the area to contain the CS/CP elements returned. Each element is a
|
||
|
|
pair of Binary(4) values. For each pair, the first value is the character set
|
||
|
|
and the second value is the code page.</p>
|
||
|
|
</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; field type: 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">CCSID1 value is not in the CCSID
|
||
|
|
resource repository.</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
|
||
|
|
for indicating a default 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">0004</td>
|
||
|
|
<td align="center" valign="top">0001</td>
|
||
|
|
<td align="left" valign="top">The allocated length (value of N1)
|
||
|
|
for the area to contain returned values was insufficient to contain all the
|
||
|
|
output data that is to be returned.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">0005</td>
|
||
|
|
<td align="center" valign="top">0002</td>
|
||
|
|
<td align="left" valign="top">N2 is greater than N1. However, the
|
||
|
|
start of the next block of data to be returned is outside the valid range 1 to
|
||
|
|
N2max.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">0005</td>
|
||
|
|
<td align="center" valign="top">000A</td>
|
||
|
|
<td align="left" valign="top">N2 is less than or equal to N1, but
|
||
|
|
is not 0.</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 incorrect in the structure.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">0007</td>
|
||
|
|
<td align="center" valign="top">0004</td>
|
||
|
|
<td align="left" valign="top">There was no ES element definition in
|
||
|
|
the CCSID resource for CCSID1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">0007</td>
|
||
|
|
<td align="center" valign="top">0006</td>
|
||
|
|
<td align="left" valign="top">There was no definition for CS, CP
|
||
|
|
elements in the CCSID resource for CCSID1.</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">N1 value is greater than the maximum
|
||
|
|
allowed in this implementation, or N1 is odd.</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>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>The maximum number of (CS, CP) values depends on the ES. Most CCSIDs have
|
||
|
|
only one pair of (CS, CP) values. A calling function can set N1 to 32, to
|
||
|
|
accommodate up to 16 pairs of (CS, CP) values without overflow.</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>
|
||
|
|
|