<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>ICU 53.1: ucoleitr.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ICU 53.1
 <span id="projectnumber">53.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_50278085fbfb203a4ae8d13ac447741e.html">i18n</a></li><li class="navelem"><a class="el" href="dir_47d86980f74387e1e780cfdfbee4bf19.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ucoleitr.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: UCollationElements.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/>
<code>#include "<a class="el" href="ucol_8h_source.html">unicode/ucol.h</a>"</code><br/>
</div>
<p><a href="ucoleitr_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a07efa63d179b459db763ffcfe16fdef8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a07efa63d179b459db763ffcfe16fdef8">UCOL_NULLORDER</a>   ((int32_t)0xFFFFFFFF)</td></tr>
<tr class="memdesc:a07efa63d179b459db763ffcfe16fdef8"><td class="mdescLeft"> </td><td class="mdescRight">This indicates an error has occured during processing or if no more CEs is to be returned. <a href="#a07efa63d179b459db763ffcfe16fdef8">More...</a><br/></td></tr>
<tr class="separator:a07efa63d179b459db763ffcfe16fdef8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5f2296c3961afacfbba2a5ee850ca1d5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a></td></tr>
<tr class="memdesc:a5f2296c3961afacfbba2a5ee850ca1d5"><td class="mdescLeft"> </td><td class="mdescRight">The UCollationElements struct. <a href="#a5f2296c3961afacfbba2a5ee850ca1d5">More...</a><br/></td></tr>
<tr class="separator:a5f2296c3961afacfbba2a5ee850ca1d5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1b02b847bb095a5525ed4b7f55a69eb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a1b02b847bb095a5525ed4b7f55a69eb5">ucol_openElements</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t textLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1b02b847bb095a5525ed4b7f55a69eb5"><td class="mdescLeft"> </td><td class="mdescRight">Open the collation elements for a string. <a href="#a1b02b847bb095a5525ed4b7f55a69eb5">More...</a><br/></td></tr>
<tr class="separator:a1b02b847bb095a5525ed4b7f55a69eb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a705331b3ca250e3f5f74accfee861fa4"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a705331b3ca250e3f5f74accfee861fa4">ucol_keyHashCode</a> (const uint8_t *key, int32_t length)</td></tr>
<tr class="memdesc:a705331b3ca250e3f5f74accfee861fa4"><td class="mdescLeft"> </td><td class="mdescRight">get a hash code for a key... <a href="#a705331b3ca250e3f5f74accfee861fa4">More...</a><br/></td></tr>
<tr class="separator:a705331b3ca250e3f5f74accfee861fa4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38185a0b06fe59058c4ed4a87c6d7ff9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a38185a0b06fe59058c4ed4a87c6d7ff9">ucol_closeElements</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems)</td></tr>
<tr class="memdesc:a38185a0b06fe59058c4ed4a87c6d7ff9"><td class="mdescLeft"> </td><td class="mdescRight">Close a UCollationElements. <a href="#a38185a0b06fe59058c4ed4a87c6d7ff9">More...</a><br/></td></tr>
<tr class="separator:a38185a0b06fe59058c4ed4a87c6d7ff9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9b4a63d9bba05b4635c0d2626b45a37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#af9b4a63d9bba05b4635c0d2626b45a37">ucol_reset</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems)</td></tr>
<tr class="memdesc:af9b4a63d9bba05b4635c0d2626b45a37"><td class="mdescLeft"> </td><td class="mdescRight">Reset the collation elements to their initial state. <a href="#af9b4a63d9bba05b4635c0d2626b45a37">More...</a><br/></td></tr>
<tr class="separator:af9b4a63d9bba05b4635c0d2626b45a37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afac0d24bf026d9ea4933cef911022370"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370">ucol_next</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:afac0d24bf026d9ea4933cef911022370"><td class="mdescLeft"> </td><td class="mdescRight">Get the ordering priority of the next collation element in the text. <a href="#afac0d24bf026d9ea4933cef911022370">More...</a><br/></td></tr>
<tr class="separator:afac0d24bf026d9ea4933cef911022370"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6718e09e014e8dcde9f0bae75fe96f5"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#ad6718e09e014e8dcde9f0bae75fe96f5">ucol_previous</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ad6718e09e014e8dcde9f0bae75fe96f5"><td class="mdescLeft"> </td><td class="mdescRight">Get the ordering priority of the previous collation element in the text. <a href="#ad6718e09e014e8dcde9f0bae75fe96f5">More...</a><br/></td></tr>
<tr class="separator:ad6718e09e014e8dcde9f0bae75fe96f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab87f69840736227870f8b1d47b6ddffd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#ab87f69840736227870f8b1d47b6ddffd">ucol_getMaxExpansion</a> (const <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems, int32_t order)</td></tr>
<tr class="memdesc:ab87f69840736227870f8b1d47b6ddffd"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum length of any expansion sequences that end with the specified comparison order. <a href="#ab87f69840736227870f8b1d47b6ddffd">More...</a><br/></td></tr>
<tr class="separator:ab87f69840736227870f8b1d47b6ddffd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb1bfe771ae3ff78dd52be29390e81fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#adb1bfe771ae3ff78dd52be29390e81fe">ucol_setText</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *text, int32_t textLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:adb1bfe771ae3ff78dd52be29390e81fe"><td class="mdescLeft"> </td><td class="mdescRight">Set the text containing the collation elements. <a href="#adb1bfe771ae3ff78dd52be29390e81fe">More...</a><br/></td></tr>
<tr class="separator:adb1bfe771ae3ff78dd52be29390e81fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03951847045960de23b022dc4722cda0"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a03951847045960de23b022dc4722cda0">ucol_getOffset</a> (const <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems)</td></tr>
<tr class="memdesc:a03951847045960de23b022dc4722cda0"><td class="mdescLeft"> </td><td class="mdescRight">Get the offset of the current source character. <a href="#a03951847045960de23b022dc4722cda0">More...</a><br/></td></tr>
<tr class="separator:a03951847045960de23b022dc4722cda0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa301bde0ec5eca09f5f069dd3ce934c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#aa301bde0ec5eca09f5f069dd3ce934c4">ucol_setOffset</a> (<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> *elems, int32_t offset, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa301bde0ec5eca09f5f069dd3ce934c4"><td class="mdescLeft"> </td><td class="mdescRight">Set the offset of the current source character. <a href="#aa301bde0ec5eca09f5f069dd3ce934c4">More...</a><br/></td></tr>
<tr class="separator:aa301bde0ec5eca09f5f069dd3ce934c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a346bfd807642b81527581c6194f003dd"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a346bfd807642b81527581c6194f003dd">ucol_primaryOrder</a> (int32_t order)</td></tr>
<tr class="memdesc:a346bfd807642b81527581c6194f003dd"><td class="mdescLeft"> </td><td class="mdescRight">Get the primary order of a collation order. <a href="#a346bfd807642b81527581c6194f003dd">More...</a><br/></td></tr>
<tr class="separator:a346bfd807642b81527581c6194f003dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5afa9446c3f57ab675f74d91d4d04b2e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a5afa9446c3f57ab675f74d91d4d04b2e">ucol_secondaryOrder</a> (int32_t order)</td></tr>
<tr class="memdesc:a5afa9446c3f57ab675f74d91d4d04b2e"><td class="mdescLeft"> </td><td class="mdescRight">Get the secondary order of a collation order. <a href="#a5afa9446c3f57ab675f74d91d4d04b2e">More...</a><br/></td></tr>
<tr class="separator:a5afa9446c3f57ab675f74d91d4d04b2e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a469d805add17198dc5c118700c04b35a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucoleitr_8h.html#a469d805add17198dc5c118700c04b35a">ucol_tertiaryOrder</a> (int32_t order)</td></tr>
<tr class="memdesc:a469d805add17198dc5c118700c04b35a"><td class="mdescLeft"> </td><td class="mdescRight">Get the tertiary order of a collation order. <a href="#a469d805add17198dc5c118700c04b35a">More...</a><br/></td></tr>
<tr class="separator:a469d805add17198dc5c118700c04b35a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: UCollationElements. </p>
<p>The UCollationElements API is used as an iterator to walk through each character of an international string. Use the iterator to return the ordering priority of the positioned character. The ordering priority of a character, which we refer to as a key, defines how a character is collated in the given collation object. For example, consider the following in Slovak and in traditional Spanish collation: </p>
<pre>
. "ca" -> the first key is key('c') and second key is key('a').
. "cha" -> the first key is key('ch') and second key is key('a').
</pre><p> And in German phonebook collation, </p>
<pre>
. "<ae ligature>b"-> the first key is key('a'), the second key is key('e'), and
. the third key is key('b').
</pre> <p>Example of the iterator usage: (without error checking) </p>
<pre>
. void CollationElementIterator_Example()
. {
. UChar *s;
. t_int32 order, primaryOrder;
. UCollationElements *c;
. UCollatorOld *coll;
. UErrorCode success = U_ZERO_ERROR;
. s=(UChar*)malloc(sizeof(UChar) * (strlen("This is a test")+1) );
. u_uastrcpy(s, "This is a test");
. coll = ucol_open(NULL, &success);
. c = ucol_openElements(coll, str, u_strlen(str), &status);
. order = ucol_next(c, &success);
. ucol_reset(c);
. order = ucol_prev(c, &success);
. free(s);
. ucol_close(coll);
. ucol_closeElements(c);
. }
</pre> <p><a class="el" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370" title="Get the ordering priority of the next collation element in the text. ">ucol_next()</a> returns the collation order of the next. ucol_prev() returns the collation order of the previous character. The Collation Element Iterator moves only in one direction between calls to ucol_reset. That is, <a class="el" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370" title="Get the ordering priority of the next collation element in the text. ">ucol_next()</a> and ucol_prev can not be inter-used. Whenever ucol_prev is to be called after <a class="el" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370" title="Get the ordering priority of the next collation element in the text. ">ucol_next()</a> or vice versa, ucol_reset has to be called first to reset the status, shifting pointers to either the end or the start of the string. Hence at the next call of ucol_prev or ucol_next, the first or last collation order will be returned. If a change of direction is done without a ucol_reset, the result is undefined. The result of a forward iterate (ucol_next) and reversed result of the backward iterate (ucol_prev) on the same string are equivalent, if collation orders with the value 0 are ignored. Character based on the comparison level of the collator. A collation order consists of primary order, secondary order and tertiary order. The data type of the collation order is <b>int32_t</b>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081" title="structure representing a collator object instance ">UCollator</a> </dd></dl>
<p>Definition in file <a class="el" href="ucoleitr_8h_source.html">ucoleitr.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a07efa63d179b459db763ffcfe16fdef8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UCOL_NULLORDER   ((int32_t)0xFFFFFFFF)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This indicates an error has occured during processing or if no more CEs is to be returned. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004584">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucoleitr_8h_source.html#l00028">28</a> of file <a class="el" href="ucoleitr_8h_source.html">ucoleitr.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a5f2296c3961afacfbba2a5ee850ca1d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The UCollationElements struct. </p>
<p>For usage in C programs. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004585">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucoleitr_8h_source.html#l00037">37</a> of file <a class="el" href="ucoleitr_8h_source.html">ucoleitr.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a38185a0b06fe59058c4ed4a87c6d7ff9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_closeElements </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a UCollationElements. </p>
<p>Once closed, a UCollationElements may no longer be used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements to close. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004588">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ab87f69840736227870f8b1d47b6ddffd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getMaxExpansion </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>order</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum length of any expansion sequences that end with the specified comparison order. </p>
<p>This is useful for .... ? </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements containing the text. </td></tr>
<tr><td class="paramname">order</td><td>A collation order returned by previous or next. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>maximum size of the expansion sequences ending with the collation element or 1 if collation element does not occur at the end of any expansion sequence </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004592">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a03951847045960de23b022dc4722cda0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getOffset </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the offset of the current source character. </p>
<p>This is an offset into the text of the character containing the current collation elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The offset of the current source character. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucoleitr_8h.html#aa301bde0ec5eca09f5f069dd3ce934c4" title="Set the offset of the current source character. ">ucol_setOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004594">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a705331b3ca250e3f5f74accfee861fa4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_keyHashCode </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get a hash code for a key... </p>
<p>Not very useful! </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the given key. </td></tr>
<tr><td class="paramname">length</td><td>the size of the key array. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the hash code. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004587">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="afac0d24bf026d9ea4933cef911022370"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the ordering priority of the next collation element in the text. </p>
<p>A single character may contain more than one collation element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements containing the text. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The next collation elements ordering, otherwise returns NULLORDER if an error has occured or if the end of string has been reached </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004590">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1b02b847bb095a5525ed4b7f55a69eb5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a>* ucol_openElements </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>coll</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the collation elements for a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The collator containing the desired collation rules. </td></tr>
<tr><td class="paramname">text</td><td>The text to iterate over. </td></tr>
<tr><td class="paramname">textLength</td><td>The number of characters in text, or -1 if null-terminated </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a struct containing collation element information </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004586">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad6718e09e014e8dcde9f0bae75fe96f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_previous </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the ordering priority of the previous collation element in the text. </p>
<p>A single character may contain more than one collation element. Note that internally a stack is used to store buffered collation elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements containing the text. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. Noteably a U_BUFFER_OVERFLOW_ERROR is returned if the internal stack buffer has been exhausted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The previous collation elements ordering, otherwise returns NULLORDER if an error has occured or if the start of string has been reached. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004591">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a346bfd807642b81527581c6194f003dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_primaryOrder </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the primary order of a collation order. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the collation order </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the primary order of a collation order. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004596">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="af9b4a63d9bba05b4635c0d2626b45a37"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the collation elements to their initial state. </p>
<p>This will move the 'cursor' to the beginning of the text. Property settings for collation will be reset to the current status. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements to reset. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370" title="Get the ordering priority of the next collation element in the text. ">ucol_next</a> </dd>
<dd>
<a class="el" href="ucoleitr_8h.html#ad6718e09e014e8dcde9f0bae75fe96f5" title="Get the ordering priority of the previous collation element in the text. ">ucol_previous</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004589">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5afa9446c3f57ab675f74d91d4d04b2e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_secondaryOrder </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the secondary order of a collation order. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the collation order </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the secondary order of a collation order. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004597">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="aa301bde0ec5eca09f5f069dd3ce934c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the offset of the current source character. </p>
<p>This is an offset into the text of the character to be processed. Property settings for collation will remain the same. In order to reset the iterator to the current collation property settings, the API reset() has to be called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements to set. </td></tr>
<tr><td class="paramname">offset</td><td>The desired character offset. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucoleitr_8h.html#a03951847045960de23b022dc4722cda0" title="Get the offset of the current source character. ">ucol_getOffset</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004595">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="adb1bfe771ae3ff78dd52be29390e81fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5">UCollationElements</a> * </td>
<td class="paramname"><em>elems</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>textLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the text containing the collation elements. </p>
<p>Property settings for collation will remain the same. In order to reset the iterator to the current collation property settings, the API reset() has to be called. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elems</td><td>The UCollationElements to set. </td></tr>
<tr><td class="paramname">text</td><td>The source text containing the collation elements. </td></tr>
<tr><td class="paramname">textLength</td><td>The length of text, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd>ucol_getText </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004593">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a469d805add17198dc5c118700c04b35a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_tertiaryOrder </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>order</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the tertiary order of a collation order. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">order</td><td>the collation order </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the tertiary order of a collation order. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004598">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-updates
>
by-pkgid
>
67d6f1fcdf59eeb6f1363fc33c40091c
>
files
>
1318
