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

253 lines
7.5 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>Resolve Client Server CCSID (QTQRCSC) 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>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Resolve Client Server CCSID (QTQRCSC) 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="50%">Server CCSID</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Int(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Client CCSID</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">Selection</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">Resolved CCSID</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">Feedback code</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>The Resolve Client Server CCSID (QTQRCSC) API returns the CCSID that will
enable the proper transfer of data between the server and the client.</p>
<br>
<!-- 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 Parameters</h3>
<dl>
<dt><strong>Server CCSID</strong></dt>
<dd>INPUT; INT(4)
<p>A variable that contains the CCSID value for the server. This value must be
a positive number in the range 1 to 65&nbsp;533.</p>
<p>Possible values follow:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">The caller does not know the server job value. The default job
CCSID value will be used.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1-65&nbsp;533</em></td>
<td valign="top">The server CCSID value.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Client CCSID</strong></dt>
<dd>INPUT; INT(4)
<p>A variable that contains the CCSID value for the client. This value must be
a positive number in the range 1 to 65&nbsp;533.</p>
</dd>
<dt><strong>Selection</strong></dt>
<dd>INPUT; INT(4)
<p>A variable that allows the user to specify what CCSID to return. If the
resolved CCSID is not supported as a job CCSID for the system on which the API
is being called, the API returns either that CCSID or finds the closest match
for the system it is on. If the exact match is to be returned, but the CCSID is
not supported on the host system, the feedback code is set.</p>
<p>Possible values follow:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td valign="top">Return the closest match for this system. If the client CCSID
is mixed and the server system only handles single byte, find the closest match
SBCS CCSID value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td valign="top">Return an exact match for the resolved CCSID. The API will not
take into account the available support on the server. The feedback code will
be set if the CCSID value returned is not compatible with the system on which
the API is being called.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Resolved CCSID</strong></dt>
<dd>OUTPUT; INT(4)
<p>A variable that contains the resolved CCSID value. This value must be a
positive number in the range 1 to 65&nbsp;279.</p>
</dd>
<dt><strong>Feedback code</strong></dt>
<dd>OUTPUT; FEEDBACK
<p>In this feedback array, the function returns the processing status (and any
associated reason) for this function. The field type is an 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 the feedback code. The other 64 bits are reserved.</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">0007</td>
<td align="left" valign="top">The user requested a CCSID for a
mixed system, and the API is being called on an SBCS system. An exact match was
requested, so a warning is returned to indicate that the CCSID returned is not
not valid as a job CCSID for the system on which this API is running.</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">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>
</table>
<br>
<br>
<h3>Usage Notes</h3>
<ol>
<li>This API uses the Get Related Default CCSID (CDRGRDC) and Get Encoding
Scheme, Character Set, and Code Page Elements (CDRGESP) APIs to perform its
functions. If any errors are found on the calls to these APIs, the feedback
code is set to those values. Refer to the documentation for these two APIs for
more feedback codes.</li>
</ol>
<hr>
API introduced: V4R1
<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>