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

171 lines
4.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">
<!-- 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 -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
<title>iconv_close()--Code Conversion Deallocation API</title>
</head>
<body><!--End Header Records -->
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>iconv_close()--Code Conversion Deallocation API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
#include &lt;iconv.h&gt;
int <strong>iconv_close (<em>cd</em>)
</strong>
iconv_t cd;
</pre>
<br>
&nbsp;&nbsp;Service Program: QTQICONV<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Conditional; see <a href="#USAGE_NOTES">Usage
Notes</a>.<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>iconv_close()</strong> function closes the conversion descriptor
cd that was initialized by the <strong>iconv_open()</strong> or <strong>
QtqIconvOpen()</strong> function.</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>Parameters</h3>
<dl>
<dt><strong>cd</strong></dt>
<dd>INPUT
<p>The conversion descriptor returned by a previous successful call to <strong>
iconv_open()</strong> or <strong>QtqIconvOpen()</strong>.</p>
</dd>
</dl>
<br>
<h3>Return Value</h3>
<p>If an error occurs, <strong>iconv_close()</strong> returns a value of -1 and
<strong>errno</strong> is set to indicate the error. If <strong>
iconv_close()</strong> completes successfully, a value of zero is returned.</p>
<br>
<h3>Error Conditions</h3>
<p>The following errors can be returned in <strong>errno</strong>:</p>
<dl>
<dt><strong>[EBADF]</strong></dt>
<dd>Descriptor not valid.
<p>The conversion descriptor (cd) parameter is not valid.</p>
</dd>
<dt><strong>[EUNKNOWN]</strong></dt>
<dd>Undetected error
<p>An undetected error occurred. Contact your service organization. An escape
message may also be signaled as a result.</p>
</dd>
</dl>
<p>The following escape messages can be signaled:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Escape Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
</table>
<br>
<br>
<h3><a name="USAGE_NOTES">Usage Notes</a></h3>
<p>This API is threadsafe if threads that share a conversion descriptor do not
attempt to preserve the shift state.</p>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="iconv.htm">iconv()</a>--Code Conversion API<br>
<br>
</li>
<li><a href="iconvopn.htm">iconv_open()</a>--Code Conversion Allocation API<br>
<br>
</li>
<li><a href="QTQICONV.htm">QtqIconvOpen()</a>--Code Conversion Allocation
API</li>
</ul>
<hr>
API introduced: V3R1
<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>