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

145 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">
<title>UniNextCompChar()--Advance to Next Composite Character Sequence API</title>
<!-- 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. -->
<!-- Begin Header Records ========================================== -->
<!-- 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>UniNextCompChar()--Advance to Next Composite Character Sequence API</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
#include &lt;UniChar.h&gt;
int UniNextCompChar(void <em>*reserved</em>,
UniChar <em>*ucs</em>,
UniChar <em>**next_sequence</em>);
</pre>
<br>
&nbsp;&nbsp;Service Program: QTQULSFN<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>UniNextCompChar</strong>--Advance to Next Composite Character Sequence function locates the next non-combining character in the string ucs.</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>reserved</strong></dt>
<dd>INPUT; PTR(SPP)
<p>This parameter must be set to null.</p></dd>
<dt><strong>ucs</strong></dt>
<dd>INPUT; PTR(SPP)
<p>The composite character sequence to be analyzed.</p></dd>
<dt><strong>next_sequence</strong></dt>
<dd>OUTPUT; PTR(SPP)
<p>This is set to the next non-combining character.</p></dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>zero</strong></dt>
<dd><strong>UniNextCompChar</strong> function was successful. The value returned in <em>next_sequence</em> is a pointer to the next non-combining character in ucs.<br><br></dd>
<dt><strong>non-zero</strong></dt>
<dd><strong>UniNextCompChar</strong> was not successful and <em>next_sequence</em> is set to the NULL pointer.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>If <strong>UniNextCompChar</strong> is not successful, the return value indicates one of the following errors:</p>
<table width="100%" cellpadding="5">
<!-- cols="20 80" -->
<tr>
<td align="left" valign="top">UNI_BADOBJ</td>
<td valign="top"><strong>UniNextCompChar</strong> function detected that the <em>reserved</em> parameter is not null.</td>
</tr>
<tr>
<td align="left" valign="top">UNI_INVALID</td>
<td valign="top"><strong>UniNextCompChar</strong> function detected that <em>ucs</em> is a null pointer.</td>
</tr>
<tr>
<td align="left" valign="top">UNI_NODATA</td>
<td valign="top"><strong>UniNextCompChar</strong> function detected that <em>ucs</em> points to a null code element.</td>
</tr>
<tr>
<td align="left" valign="top">UNI_COMP_FOUND</td>
<td valign="top"><strong>UniNextCompChar</strong> function detected that <em>ucs</em> points to a combining character. The caller should advance <em>ucs</em> by one UniChar and call the function again until this error no longer occurs.</td>
</tr>
<tr>
<td align="left" valign="top">UNI_RANGE</td>
<td valign="top"><strong>UniQueryCompCharLen</strong> function detected that the value to be set in <em>element_count</em> was too large to fit.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R6
<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>
</tr>
</table>
</center>
</body>
</html>