144 lines
4.6 KiB
HTML
144 lines
4.6 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>UniQueryCompChar()--Number of Composite Character Sequences 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>UniQueryCompChar()--Number of Composite Character Sequences API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Syntax<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<pre>
|
|
#include <UniChar.h>
|
|
|
|
int UniQueryCompChar(void <em>*reserved</em>,
|
|
const UniChar <em>*ucs</em>,
|
|
size_t <em>*composite_count</em>);
|
|
</pre>
|
|
<br>
|
|
Service Program: QTQULSFN<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>UniQueryCompChar</strong>--Number of Composite Character Sequences function computes the number of composite character sequences in the code element array pointed to by <em>ucs</em>. The function sets <em>composite_count</em> to be the number of sequences that consist of a base character followed by zero or more combining characters up to, but not including, the null code element.</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>The reserved 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>composite_count</strong></dt>
|
|
<dd>OUTPUT; PTR(SPP)
|
|
|
|
<p>This is set to the number of composite character sequences in the code element array pointed to by <em>ucs</em>.</p></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Return Value</h3>
|
|
|
|
<dl>
|
|
<dt><strong>zero</strong></dt>
|
|
<dd><strong>UniQueryCompChar</strong> function was successful. The value returned in <em>composite_count</em> is the number of sequences found in <em>ucs</em>.<br><br></dd>
|
|
|
|
<dt><strong>non-zero</strong></dt>
|
|
<dd><strong>UniQueryCompChar</strong> was not successful and <em>composite_count</em> is set to zero.</dd> </dl>
|
|
|
|
<br>
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>If <strong>UniQueryCompChar</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>UniQueryCompChar</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>UniQueryCompChar</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>UniQueryCompChar</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>UniQueryCompChar</strong> function detected that <em>ucs</em> points to a combining character.</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>
|