<!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: ucol.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="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ucol.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Collator.
<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="unorm_8h_source.html">unicode/unorm.h</a>"</code><br/>
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
<code>#include "<a class="el" href="parseerr_8h_source.html">unicode/parseerr.h</a>"</code><br/>
<code>#include "<a class="el" href="uloc_8h_source.html">unicode/uloc.h</a>"</code><br/>
<code>#include "<a class="el" href="uset_8h_source.html">unicode/uset.h</a>"</code><br/>
<code>#include "<a class="el" href="uscript_8h_source.html">unicode/uscript.h</a>"</code><br/>
</div>
<p><a href="ucol_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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ab8706ece0706f5f3f2b2c3a9797ec01b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ab8706ece0706f5f3f2b2c3a9797ec01b">U_COL_SAFECLONE_BUFFERSIZE</a>   1</td></tr>
<tr class="memdesc:ab8706ece0706f5f3f2b2c3a9797ec01b"><td class="mdescLeft"> </td><td class="mdescRight">default memory size for the new clone. <a href="#ab8706ece0706f5f3f2b2c3a9797ec01b">More...</a><br/></td></tr>
<tr class="separator:ab8706ece0706f5f3f2b2c3a9797ec01b"><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:a3c4eeb412a5fd72762e6245aa75ca081"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a></td></tr>
<tr class="memdesc:a3c4eeb412a5fd72762e6245aa75ca081"><td class="mdescLeft"> </td><td class="mdescRight">structure representing a collator object instance <a href="#a3c4eeb412a5fd72762e6245aa75ca081">More...</a><br/></td></tr>
<tr class="separator:a3c4eeb412a5fd72762e6245aa75ca081"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a967f36248b0a1bc7654f538ee8ba96"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a6a967f36248b0a1bc7654f538ee8ba96">UCollationStrength</a></td></tr>
<tr class="memdesc:a6a967f36248b0a1bc7654f538ee8ba96"><td class="mdescLeft"> </td><td class="mdescRight">Base letter represents a primary difference. <a href="#a6a967f36248b0a1bc7654f538ee8ba96">More...</a><br/></td></tr>
<tr class="separator:a6a967f36248b0a1bc7654f538ee8ba96"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a8b4e71db8109af87f84ac1576e2b245d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> { <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245dad62021a93c87f18e7d7400aeae76afbe">UCOL_EQUAL</a> = 0,
<a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245dab077d467fc9b8d2f5cdebdf04e9912ae">UCOL_GREATER</a> = 1,
<a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245da3ff43a44b34460a1ca53bbe88b35a624">UCOL_LESS</a> = -1
}</td></tr>
<tr class="memdesc:a8b4e71db8109af87f84ac1576e2b245d"><td class="mdescLeft"> </td><td class="mdescRight">UCOL_LESS is returned if source string is compared to be less than target string in the <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll()</a> method. <a href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">More...</a><br/></td></tr>
<tr class="separator:a8b4e71db8109af87f84ac1576e2b245d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc801048729e684bcabed328be85f77a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> { <br/>
  <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa4463bb61ef754d062635567e42561a06">UCOL_DEFAULT</a> = -1,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aab304299c75f57c98a7d7de36e226c36e">UCOL_PRIMARY</a> = 0,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aac4748251d9391c813bec59234e74efb6">UCOL_SECONDARY</a> = 1,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa3723e1767f0718b1a74a9dfdabd9de77">UCOL_TERTIARY</a> = 2,
<br/>
  <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aafd51e6b6d3a6930fa57e96f5352ecb34">UCOL_DEFAULT_STRENGTH</a> = UCOL_TERTIARY,
<b>UCOL_CE_STRENGTH_LIMIT</b>,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa8a79d0941ea478c1360bd590748c9f41">UCOL_QUATERNARY</a> =3,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa506f0c7653777a4b344f7a5f633af26c">UCOL_IDENTICAL</a> =15,
<br/>
  <b>UCOL_STRENGTH_LIMIT</b>,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa798c0f324ab1a796c44fc1ac5961580d">UCOL_OFF</a> = 16,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aad6c6d3813dc17544960944d861893ed5">UCOL_ON</a> = 17,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa9d8c0e91ba648450330ca9dcb4d00079">UCOL_SHIFTED</a> = 20,
<br/>
  <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aac90c0ea41c9c79eeb0054060b4f598dd">UCOL_NON_IGNORABLE</a> = 21,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aab81cb97ed24b4d28dff15521e74d3000">UCOL_LOWER_FIRST</a> = 24,
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77aa20c4404d3b43e984d3afecfed7fbf3ea">UCOL_UPPER_FIRST</a> = 25,
<b>UCOL_ATTRIBUTE_VALUE_COUNT</b>
<br/>
}</td></tr>
<tr class="memdesc:acc801048729e684bcabed328be85f77a"><td class="mdescLeft"> </td><td class="mdescRight">Enum containing attribute values for controling collation behavior. <a href="ucol_8h.html#acc801048729e684bcabed328be85f77a">More...</a><br/></td></tr>
<tr class="separator:acc801048729e684bcabed328be85f77a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae491f1262ff311f19e74830eb685f887"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> { <br/>
  <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a21f7a26a846970611988c3bd5540e292">UCOL_REORDER_CODE_DEFAULT</a> = -1,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a18077893b37324c1d5753c60a437d9b4">UCOL_REORDER_CODE_NONE</a> = USCRIPT_UNKNOWN,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a1053091a40da5ad91fca2530e17e5f45">UCOL_REORDER_CODE_OTHERS</a> = USCRIPT_UNKNOWN,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a961b335efb535ce3b480c927a82cfd8e">UCOL_REORDER_CODE_SPACE</a> = 0x1000,
<br/>
  <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887ac1cdea67134c7f0815454cf0e4914b53">UCOL_REORDER_CODE_FIRST</a> = UCOL_REORDER_CODE_SPACE,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a7403925d0681a31ae6548ff12308d8fe">UCOL_REORDER_CODE_PUNCTUATION</a> = 0x1001,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a46e6d81b83777db4bf754fa8175533ab">UCOL_REORDER_CODE_SYMBOL</a> = 0x1002,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887ae2dd17d6e761e782a4c3131e89a4fa24">UCOL_REORDER_CODE_CURRENCY</a> = 0x1003,
<br/>
  <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a574ecd4c743af4bc92c4316462bd9e26">UCOL_REORDER_CODE_DIGIT</a> = 0x1004,
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887a33a969251c0d8437609c6cdd40c11da3">UCOL_REORDER_CODE_LIMIT</a> = 0x1005
<br/>
}</td></tr>
<tr class="memdesc:ae491f1262ff311f19e74830eb685f887"><td class="mdescLeft"> </td><td class="mdescRight">Enum containing the codes for reordering segments of the collation table that are not script codes. <a href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">More...</a><br/></td></tr>
<tr class="separator:ae491f1262ff311f19e74830eb685f887"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a583fbe7fc4a850e2fcc692e766d2826c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> { <br/>
  <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca580844224ecd5721b5bf4716426a268a">UCOL_FRENCH_COLLATION</a>,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826cae979ae2dd00543d6ac89936fcc500f54">UCOL_ALTERNATE_HANDLING</a>,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca04e048554399e8d90e0f84ab8a059c97">UCOL_CASE_FIRST</a>,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca5439a6821b5e3b9de592098dabef1f4e">UCOL_CASE_LEVEL</a>,
<br/>
  <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826caef5f0957c1d75026720fe4e1fafabc51">UCOL_NORMALIZATION_MODE</a>,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca62a765fae5bc78a300665939f3770803">UCOL_DECOMPOSITION_MODE</a> = UCOL_NORMALIZATION_MODE,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca46616a060f4d1d81196f27b51ef5f9ff">UCOL_STRENGTH</a>,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca60b94665bb1469bfed55543e3e9e3651">UCOL_HIRAGANA_QUATERNARY_MODE</a> = UCOL_STRENGTH + 1,
<br/>
  <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca2efca83794416797ef04abda570c6f5b">UCOL_NUMERIC_COLLATION</a> = UCOL_STRENGTH + 2,
<a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826ca9b2d19cbeac7a64b3d0354046a3c2fa0">UCOL_ATTRIBUTE_COUNT</a>
<br/>
}</td></tr>
<tr class="memdesc:a583fbe7fc4a850e2fcc692e766d2826c"><td class="mdescLeft"> </td><td class="mdescRight">Attributes that collation service understands. <a href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">More...</a><br/></td></tr>
<tr class="separator:a583fbe7fc4a850e2fcc692e766d2826c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46363290036b8dffd6862c35e7b5872f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a> { <a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872fac2d59cd7a59b9be9fe1b38dc4de593f7">UCOL_TAILORING_ONLY</a>,
<a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872fa6e027e190a33aa58b026afd48a97b67f">UCOL_FULL_RULES</a>
}</td></tr>
<tr class="memdesc:a46363290036b8dffd6862c35e7b5872f"><td class="mdescLeft"> </td><td class="mdescRight">Options for retrieving the rule string. <a href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">More...</a><br/></td></tr>
<tr class="separator:a46363290036b8dffd6862c35e7b5872f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b11e0e399df62d3048174b8309657c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a> { <a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657ca07971cd4fb76b1ac281462f5b2a70fd5">UCOL_BOUND_LOWER</a> = 0,
<a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657ca398433c7f3d342924c2cc3d537dd75ce">UCOL_BOUND_UPPER</a> = 1,
<a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657cab3acc199e3c1c44251a2b7f2d13633a6">UCOL_BOUND_UPPER_LONG</a> = 2,
<b>UCOL_BOUND_VALUE_COUNT</b>
}</td></tr>
<tr class="memdesc:aa3b11e0e399df62d3048174b8309657c"><td class="mdescLeft"> </td><td class="mdescRight">enum that is taken by ucol_getBound API See below for explanation do not change the values assigned to the members of this enum. <a href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">More...</a><br/></td></tr>
<tr class="separator:aa3b11e0e399df62d3048174b8309657c"><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:a4721e4c0a519bb0139a874e191223590"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a4721e4c0a519bb0139a874e191223590">ucol_open</a> (const char *loc, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a4721e4c0a519bb0139a874e191223590"><td class="mdescLeft"> </td><td class="mdescRight">Open a UCollator for comparing strings. <a href="#a4721e4c0a519bb0139a874e191223590">More...</a><br/></td></tr>
<tr class="separator:a4721e4c0a519bb0139a874e191223590"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa128ea0ed3869415c1c96a9a2c997c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#aa128ea0ed3869415c1c96a9a2c997c2d">ucol_openRules</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *rules, int32_t rulesLength, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> normalizationMode, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> strength, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa128ea0ed3869415c1c96a9a2c997c2d"><td class="mdescLeft"> </td><td class="mdescRight">Produce a UCollator instance according to the rules supplied. <a href="#aa128ea0ed3869415c1c96a9a2c997c2d">More...</a><br/></td></tr>
<tr class="separator:aa128ea0ed3869415c1c96a9a2c997c2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39ccd61fb814dc0d2e759bc0cfe4c80d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a39ccd61fb814dc0d2e759bc0cfe4c80d">ucol_openFromShortString</a> (const char *definition, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> forceDefaults, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a39ccd61fb814dc0d2e759bc0cfe4c80d"><td class="mdescLeft"> </td><td class="mdescRight">Open a collator defined by a short form string. <a href="#a39ccd61fb814dc0d2e759bc0cfe4c80d">More...</a><br/></td></tr>
<tr class="separator:a39ccd61fb814dc0d2e759bc0cfe4c80d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60a1437827161a2f33a4dd44e27ef02a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a60a1437827161a2f33a4dd44e27ef02a">ucol_getContractions</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *conts, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a60a1437827161a2f33a4dd44e27ef02a"><td class="mdescLeft"> </td><td class="mdescRight">Get a set containing the contractions defined by the collator. <a href="#a60a1437827161a2f33a4dd44e27ef02a">More...</a><br/></td></tr>
<tr class="separator:a60a1437827161a2f33a4dd44e27ef02a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a395afb2b873efee82430ac0ab2388250"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a395afb2b873efee82430ac0ab2388250">ucol_getContractionsAndExpansions</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *contractions, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *expansions, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> addPrefixes, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a395afb2b873efee82430ac0ab2388250"><td class="mdescLeft"> </td><td class="mdescRight">Get a set containing the expansions defined by the collator. <a href="#a395afb2b873efee82430ac0ab2388250">More...</a><br/></td></tr>
<tr class="separator:a395afb2b873efee82430ac0ab2388250"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68fce4fae47371bfece8a288ef05f11f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a68fce4fae47371bfece8a288ef05f11f">ucol_close</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll)</td></tr>
<tr class="memdesc:a68fce4fae47371bfece8a288ef05f11f"><td class="mdescLeft"> </td><td class="mdescRight">Close a UCollator. <a href="#a68fce4fae47371bfece8a288ef05f11f">More...</a><br/></td></tr>
<tr class="separator:a68fce4fae47371bfece8a288ef05f11f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa194d8b0092106c0fea4070060790694"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694">ucol_strcoll</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength)</td></tr>
<tr class="memdesc:aa194d8b0092106c0fea4070060790694"><td class="mdescLeft"> </td><td class="mdescRight">Compare two strings. <a href="#aa194d8b0092106c0fea4070060790694">More...</a><br/></td></tr>
<tr class="separator:aa194d8b0092106c0fea4070060790694"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3abc6779e6452106415918199308fab4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a3abc6779e6452106415918199308fab4">ucol_strcollUTF8</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const char *source, int32_t sourceLength, const char *target, int32_t targetLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a3abc6779e6452106415918199308fab4"><td class="mdescLeft"> </td><td class="mdescRight">Compare two strings in UTF-8. <a href="#a3abc6779e6452106415918199308fab4">More...</a><br/></td></tr>
<tr class="separator:a3abc6779e6452106415918199308fab4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9eb676fde40581f43cc7eb24b597e0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#aa9eb676fde40581f43cc7eb24b597e0e">ucol_greater</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength)</td></tr>
<tr class="memdesc:aa9eb676fde40581f43cc7eb24b597e0e"><td class="mdescLeft"> </td><td class="mdescRight">Determine if one string is greater than another. <a href="#aa9eb676fde40581f43cc7eb24b597e0e">More...</a><br/></td></tr>
<tr class="separator:aa9eb676fde40581f43cc7eb24b597e0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad04f5b8001a319c71f1dc2da06519091"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ad04f5b8001a319c71f1dc2da06519091">ucol_greaterOrEqual</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength)</td></tr>
<tr class="memdesc:ad04f5b8001a319c71f1dc2da06519091"><td class="mdescLeft"> </td><td class="mdescRight">Determine if one string is greater than or equal to another. <a href="#ad04f5b8001a319c71f1dc2da06519091">More...</a><br/></td></tr>
<tr class="separator:ad04f5b8001a319c71f1dc2da06519091"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad592bf65b8b5859ea06ab565f0e6e869"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ad592bf65b8b5859ea06ab565f0e6e869">ucol_equal</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *target, int32_t targetLength)</td></tr>
<tr class="memdesc:ad592bf65b8b5859ea06ab565f0e6e869"><td class="mdescLeft"> </td><td class="mdescRight">Compare two strings for equality. <a href="#ad592bf65b8b5859ea06ab565f0e6e869">More...</a><br/></td></tr>
<tr class="separator:ad592bf65b8b5859ea06ab565f0e6e869"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad62f08d678b62cf17825f3237ff0315c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ad62f08d678b62cf17825f3237ff0315c">ucol_strcollIter</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="structUCharIterator.html">UCharIterator</a> *sIter, <a class="el" href="structUCharIterator.html">UCharIterator</a> *tIter, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ad62f08d678b62cf17825f3237ff0315c"><td class="mdescLeft"> </td><td class="mdescRight">Compare two UTF-8 encoded trings. <a href="#ad62f08d678b62cf17825f3237ff0315c">More...</a><br/></td></tr>
<tr class="separator:ad62f08d678b62cf17825f3237ff0315c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc4eaea4396300af64c5891fc6c4c0a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#abc4eaea4396300af64c5891fc6c4c0a6">ucol_getStrength</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll)</td></tr>
<tr class="memdesc:abc4eaea4396300af64c5891fc6c4c0a6"><td class="mdescLeft"> </td><td class="mdescRight">Get the collation strength used in a UCollator. <a href="#abc4eaea4396300af64c5891fc6c4c0a6">More...</a><br/></td></tr>
<tr class="separator:abc4eaea4396300af64c5891fc6c4c0a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcbb3eee538142a06a89e066400dd9b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#adcbb3eee538142a06a89e066400dd9b7">ucol_setStrength</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> strength)</td></tr>
<tr class="memdesc:adcbb3eee538142a06a89e066400dd9b7"><td class="mdescLeft"> </td><td class="mdescRight">Set the collation strength used in a UCollator. <a href="#adcbb3eee538142a06a89e066400dd9b7">More...</a><br/></td></tr>
<tr class="separator:adcbb3eee538142a06a89e066400dd9b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e3ad662b7141615599dbe11c3c0e328"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a6e3ad662b7141615599dbe11c3c0e328">ucol_getReorderCodes</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, int32_t *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a6e3ad662b7141615599dbe11c3c0e328"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reordering codes for this collator. <a href="#a6e3ad662b7141615599dbe11c3c0e328">More...</a><br/></td></tr>
<tr class="separator:a6e3ad662b7141615599dbe11c3c0e328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7473236c4a96983fc1c53c9ab566c2e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3">ucol_setReorderCodes</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const int32_t *reorderCodes, int32_t reorderCodesLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a7473236c4a96983fc1c53c9ab566c2e3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the reordering codes for this collator. <a href="#a7473236c4a96983fc1c53c9ab566c2e3">More...</a><br/></td></tr>
<tr class="separator:a7473236c4a96983fc1c53c9ab566c2e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d52959dc92e90d2bccc800fab679e65"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a3d52959dc92e90d2bccc800fab679e65">ucol_getEquivalentReorderCodes</a> (int32_t reorderCode, int32_t *dest, int32_t destCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a3d52959dc92e90d2bccc800fab679e65"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reorder codes that are grouped with the given reorder code. <a href="#a3d52959dc92e90d2bccc800fab679e65">More...</a><br/></td></tr>
<tr class="separator:a3d52959dc92e90d2bccc800fab679e65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa29f34789ceeada3021c1219c93d7653"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#aa29f34789ceeada3021c1219c93d7653">ucol_getDisplayName</a> (const char *objLoc, const char *dispLoc, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *result, int32_t resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa29f34789ceeada3021c1219c93d7653"><td class="mdescLeft"> </td><td class="mdescRight">Get the display name for a UCollator. <a href="#aa29f34789ceeada3021c1219c93d7653">More...</a><br/></td></tr>
<tr class="separator:aa29f34789ceeada3021c1219c93d7653"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e375872b21ab6286258638dcf3817c0"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a0e375872b21ab6286258638dcf3817c0">ucol_getAvailable</a> (int32_t localeIndex)</td></tr>
<tr class="memdesc:a0e375872b21ab6286258638dcf3817c0"><td class="mdescLeft"> </td><td class="mdescRight">Get a locale for which collation rules are available. <a href="#a0e375872b21ab6286258638dcf3817c0">More...</a><br/></td></tr>
<tr class="separator:a0e375872b21ab6286258638dcf3817c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd3f9bd0c933c74cb36723f524c91d19"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#abd3f9bd0c933c74cb36723f524c91d19">ucol_countAvailable</a> (void)</td></tr>
<tr class="memdesc:abd3f9bd0c933c74cb36723f524c91d19"><td class="mdescLeft"> </td><td class="mdescRight">Determine how many locales have collation rules available. <a href="#abd3f9bd0c933c74cb36723f524c91d19">More...</a><br/></td></tr>
<tr class="separator:abd3f9bd0c933c74cb36723f524c91d19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29eccc8e4136301e7c6b5e295cefda9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a29eccc8e4136301e7c6b5e295cefda9e">ucol_openAvailableLocales</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a29eccc8e4136301e7c6b5e295cefda9e"><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator of all locales for which a valid collator may be opened. <a href="#a29eccc8e4136301e7c6b5e295cefda9e">More...</a><br/></td></tr>
<tr class="separator:a29eccc8e4136301e7c6b5e295cefda9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a8d9b9578d6238395ddb748e2ebe1dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a5a8d9b9578d6238395ddb748e2ebe1dd">ucol_getKeywords</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a5a8d9b9578d6238395ddb748e2ebe1dd"><td class="mdescLeft"> </td><td class="mdescRight">Create a string enumerator of all possible keywords that are relevant to collation. <a href="#a5a8d9b9578d6238395ddb748e2ebe1dd">More...</a><br/></td></tr>
<tr class="separator:a5a8d9b9578d6238395ddb748e2ebe1dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a647734f3924283c92f6fbbafcc40eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a1a647734f3924283c92f6fbbafcc40eb">ucol_getKeywordValues</a> (const char *keyword, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1a647734f3924283c92f6fbbafcc40eb"><td class="mdescLeft"> </td><td class="mdescRight">Given a keyword, create a string enumeration of all values for that keyword that are currently in use. <a href="#a1a647734f3924283c92f6fbbafcc40eb">More...</a><br/></td></tr>
<tr class="separator:a1a647734f3924283c92f6fbbafcc40eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b188d4076f7603844bb7896f1cc0e43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a2b188d4076f7603844bb7896f1cc0e43">ucol_getKeywordValuesForLocale</a> (const char *key, const char *locale, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> commonlyUsed, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a2b188d4076f7603844bb7896f1cc0e43"><td class="mdescLeft"> </td><td class="mdescRight">Given a key and a locale, returns an array of string values in a preferred order that would make a difference. <a href="#a2b188d4076f7603844bb7896f1cc0e43">More...</a><br/></td></tr>
<tr class="separator:a2b188d4076f7603844bb7896f1cc0e43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8d6d6df31c7fad5a4f93cc8beb6eeaf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#af8d6d6df31c7fad5a4f93cc8beb6eeaf">ucol_getFunctionalEquivalent</a> (char *result, int32_t resultCapacity, const char *keyword, const char *locale, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> *isAvailable, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:af8d6d6df31c7fad5a4f93cc8beb6eeaf"><td class="mdescLeft"> </td><td class="mdescRight">Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service. <a href="#af8d6d6df31c7fad5a4f93cc8beb6eeaf">More...</a><br/></td></tr>
<tr class="separator:af8d6d6df31c7fad5a4f93cc8beb6eeaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8085a8ab866292a6ff92720b861aa5a6"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a8085a8ab866292a6ff92720b861aa5a6">ucol_getRules</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, int32_t *length)</td></tr>
<tr class="memdesc:a8085a8ab866292a6ff92720b861aa5a6"><td class="mdescLeft"> </td><td class="mdescRight">Get the collation tailoring rules from a UCollator. <a href="#a8085a8ab866292a6ff92720b861aa5a6">More...</a><br/></td></tr>
<tr class="separator:a8085a8ab866292a6ff92720b861aa5a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a762daeafd0df7cc65fd120a1e802cbbe"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a762daeafd0df7cc65fd120a1e802cbbe">ucol_getShortDefinitionString</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const char *locale, char *buffer, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a762daeafd0df7cc65fd120a1e802cbbe"><td class="mdescLeft"> </td><td class="mdescRight">Get the short definition string for a collator. <a href="#a762daeafd0df7cc65fd120a1e802cbbe">More...</a><br/></td></tr>
<tr class="separator:a762daeafd0df7cc65fd120a1e802cbbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4527a9eefdd7e071fff9d87b2e418cfa"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a4527a9eefdd7e071fff9d87b2e418cfa">ucol_normalizeShortDefinitionString</a> (const char *source, char *destination, int32_t capacity, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a4527a9eefdd7e071fff9d87b2e418cfa"><td class="mdescLeft"> </td><td class="mdescRight">Verifies and normalizes short definition string. <a href="#a4527a9eefdd7e071fff9d87b2e418cfa">More...</a><br/></td></tr>
<tr class="separator:a4527a9eefdd7e071fff9d87b2e418cfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f83f9c96a0950e2c22bd5c5c31ff6bf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a1f83f9c96a0950e2c22bd5c5c31ff6bf">ucol_getSortKey</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *source, int32_t sourceLength, uint8_t *result, int32_t resultLength)</td></tr>
<tr class="memdesc:a1f83f9c96a0950e2c22bd5c5c31ff6bf"><td class="mdescLeft"> </td><td class="mdescRight">Get a sort key for a string from a UCollator. <a href="#a1f83f9c96a0950e2c22bd5c5c31ff6bf">More...</a><br/></td></tr>
<tr class="separator:a1f83f9c96a0950e2c22bd5c5c31ff6bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c8ed92bb13577d6cd9a129b38a05d69"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a8c8ed92bb13577d6cd9a129b38a05d69">ucol_nextSortKeyPart</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="structUCharIterator.html">UCharIterator</a> *iter, uint32_t state[2], uint8_t *dest, int32_t count, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a8c8ed92bb13577d6cd9a129b38a05d69"><td class="mdescLeft"> </td><td class="mdescRight">Gets the next count bytes of a sort key. <a href="#a8c8ed92bb13577d6cd9a129b38a05d69">More...</a><br/></td></tr>
<tr class="separator:a8c8ed92bb13577d6cd9a129b38a05d69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbaf099e596089c777f297a39d2af753"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#acbaf099e596089c777f297a39d2af753">ucol_getBound</a> (const uint8_t *source, int32_t sourceLength, <a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a> boundType, uint32_t noOfLevels, uint8_t *result, int32_t resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:acbaf099e596089c777f297a39d2af753"><td class="mdescLeft"> </td><td class="mdescRight">Produce a bound for a given sortkey and a number of levels. <a href="#acbaf099e596089c777f297a39d2af753">More...</a><br/></td></tr>
<tr class="separator:acbaf099e596089c777f297a39d2af753"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af756972781ac556a62e48cbd509ea4a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#af756972781ac556a62e48cbd509ea4a6">ucol_getVersion</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> info)</td></tr>
<tr class="memdesc:af756972781ac556a62e48cbd509ea4a6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version information for a Collator. <a href="#af756972781ac556a62e48cbd509ea4a6">More...</a><br/></td></tr>
<tr class="separator:af756972781ac556a62e48cbd509ea4a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c83c7005da2dbb920437165d6248ce5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a0c83c7005da2dbb920437165d6248ce5">ucol_getUCAVersion</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> info)</td></tr>
<tr class="memdesc:a0c83c7005da2dbb920437165d6248ce5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the UCA version information for a Collator. <a href="#a0c83c7005da2dbb920437165d6248ce5">More...</a><br/></td></tr>
<tr class="separator:a0c83c7005da2dbb920437165d6248ce5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18de00ad7c0da5b2f23dfa5facdc3901"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a18de00ad7c0da5b2f23dfa5facdc3901">ucol_mergeSortkeys</a> (const uint8_t *src1, int32_t src1Length, const uint8_t *src2, int32_t src2Length, uint8_t *dest, int32_t destCapacity)</td></tr>
<tr class="memdesc:a18de00ad7c0da5b2f23dfa5facdc3901"><td class="mdescLeft"> </td><td class="mdescRight">Merges two sort keys. <a href="#a18de00ad7c0da5b2f23dfa5facdc3901">More...</a><br/></td></tr>
<tr class="separator:a18de00ad7c0da5b2f23dfa5facdc3901"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a2302e315d5b474f94354cffedeecd7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a3a2302e315d5b474f94354cffedeecd7">ucol_setAttribute</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> value, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a3a2302e315d5b474f94354cffedeecd7"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute setter. <a href="#a3a2302e315d5b474f94354cffedeecd7">More...</a><br/></td></tr>
<tr class="separator:a3a2302e315d5b474f94354cffedeecd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af96cc7dc7da7981d2d12356b104e058a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#af96cc7dc7da7981d2d12356b104e058a">ucol_getAttribute</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> attr, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:af96cc7dc7da7981d2d12356b104e058a"><td class="mdescLeft"> </td><td class="mdescRight">Universal attribute getter. <a href="#af96cc7dc7da7981d2d12356b104e058a">More...</a><br/></td></tr>
<tr class="separator:af96cc7dc7da7981d2d12356b104e058a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59507ee73d0aab54bb22f5d05d598138"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138">ucol_setMaxVariable</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> group, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *pErrorCode)</td></tr>
<tr class="memdesc:a59507ee73d0aab54bb22f5d05d598138"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the top of the specified reordering group. <a href="#a59507ee73d0aab54bb22f5d05d598138">More...</a><br/></td></tr>
<tr class="separator:a59507ee73d0aab54bb22f5d05d598138"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15526321f50d1b424e659e3726a5ece4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a15526321f50d1b424e659e3726a5ece4">ucol_getMaxVariable</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll)</td></tr>
<tr class="memdesc:a15526321f50d1b424e659e3726a5ece4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. <a href="#a15526321f50d1b424e659e3726a5ece4">More...</a><br/></td></tr>
<tr class="separator:a15526321f50d1b424e659e3726a5ece4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e9c28a8b8b88890722daca111207688"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a0e9c28a8b8b88890722daca111207688">ucol_setVariableTop</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *varTop, int32_t len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a0e9c28a8b8b88890722daca111207688"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the primary weight of the specified string. <a href="#a0e9c28a8b8b88890722daca111207688">More...</a><br/></td></tr>
<tr class="separator:a0e9c28a8b8b88890722daca111207688"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a802cc1a4f7f3e9de7089802294377867"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a802cc1a4f7f3e9de7089802294377867">ucol_getVariableTop</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a802cc1a4f7f3e9de7089802294377867"><td class="mdescLeft"> </td><td class="mdescRight">Gets the variable top value of a Collator. <a href="#a802cc1a4f7f3e9de7089802294377867">More...</a><br/></td></tr>
<tr class="separator:a802cc1a4f7f3e9de7089802294377867"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad10de03e206f2b9dceb59b59e75bc7d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ad10de03e206f2b9dceb59b59e75bc7d8">ucol_restoreVariableTop</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const uint32_t varTop, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ad10de03e206f2b9dceb59b59e75bc7d8"><td class="mdescLeft"> </td><td class="mdescRight">Sets the variable top to the specified primary weight. <a href="#ad10de03e206f2b9dceb59b59e75bc7d8">More...</a><br/></td></tr>
<tr class="separator:ad10de03e206f2b9dceb59b59e75bc7d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a917cd8e16df3b35bbe97dd96d881f227"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a917cd8e16df3b35bbe97dd96d881f227">ucol_safeClone</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, void *stackBuffer, int32_t *pBufferSize, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a917cd8e16df3b35bbe97dd96d881f227"><td class="mdescLeft"> </td><td class="mdescRight">Thread safe cloning operation. <a href="#a917cd8e16df3b35bbe97dd96d881f227">More...</a><br/></td></tr>
<tr class="separator:a917cd8e16df3b35bbe97dd96d881f227"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a318cfd0bef6d92a7aab8bef55a4e1bf7"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a318cfd0bef6d92a7aab8bef55a4e1bf7">ucol_getRulesEx</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a> delta, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *buffer, int32_t bufferLen)</td></tr>
<tr class="memdesc:a318cfd0bef6d92a7aab8bef55a4e1bf7"><td class="mdescLeft"> </td><td class="mdescRight">Returns current rules. <a href="#a318cfd0bef6d92a7aab8bef55a4e1bf7">More...</a><br/></td></tr>
<tr class="separator:a318cfd0bef6d92a7aab8bef55a4e1bf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9df9e4a23459301d723f16600ca2a7b3"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a9df9e4a23459301d723f16600ca2a7b3">ucol_getLocale</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a9df9e4a23459301d723f16600ca2a7b3"><td class="mdescLeft"> </td><td class="mdescRight">gets the locale name of the collator. <a href="#a9df9e4a23459301d723f16600ca2a7b3">More...</a><br/></td></tr>
<tr class="separator:a9df9e4a23459301d723f16600ca2a7b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade40592efde5935d3c0cd6f940d4c2e4"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#ade40592efde5935d3c0cd6f940d4c2e4">ucol_getLocaleByType</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ade40592efde5935d3c0cd6f940d4c2e4"><td class="mdescLeft"> </td><td class="mdescRight">gets the locale name of the collator. <a href="#ade40592efde5935d3c0cd6f940d4c2e4">More...</a><br/></td></tr>
<tr class="separator:ade40592efde5935d3c0cd6f940d4c2e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1982f184bca8adaa848144a1959ff235"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a1982f184bca8adaa848144a1959ff235">ucol_getTailoredSet</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a1982f184bca8adaa848144a1959ff235"><td class="mdescLeft"> </td><td class="mdescRight">Get a Unicode set that contains all the characters and sequences tailored in this collator. <a href="#a1982f184bca8adaa848144a1959ff235">More...</a><br/></td></tr>
<tr class="separator:a1982f184bca8adaa848144a1959ff235"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05602ef69e9303eab4f27f082da78cdf"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a05602ef69e9303eab4f27f082da78cdf">ucol_getUnsafeSet</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, <a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> *unsafe, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a05602ef69e9303eab4f27f082da78cdf"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the set of unsafe code points, given a collator. <a href="#a05602ef69e9303eab4f27f082da78cdf">More...</a><br/></td></tr>
<tr class="separator:a05602ef69e9303eab4f27f082da78cdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af94c268dea700c8772e7955dc2a75759"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#af94c268dea700c8772e7955dc2a75759">ucol_prepareShortStringOpen</a> (const char *definition, <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> forceDefaults, <a class="el" href="structUParseError.html">UParseError</a> *parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:af94c268dea700c8772e7955dc2a75759"><td class="mdescLeft"> </td><td class="mdescRight">Touches all resources needed for instantiating a collator from a short string definition, thus filling up the cache. <a href="#af94c268dea700c8772e7955dc2a75759">More...</a><br/></td></tr>
<tr class="separator:af94c268dea700c8772e7955dc2a75759"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2719995a75ebed7aacc1419bb2b781db"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a2719995a75ebed7aacc1419bb2b781db">ucol_cloneBinary</a> (const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, uint8_t *buffer, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a2719995a75ebed7aacc1419bb2b781db"><td class="mdescLeft"> </td><td class="mdescRight">Creates a binary image of a collator. <a href="#a2719995a75ebed7aacc1419bb2b781db">More...</a><br/></td></tr>
<tr class="separator:a2719995a75ebed7aacc1419bb2b781db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a467ea0dde69a6990f6ecbb7e30da6003"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ucol_8h.html#a467ea0dde69a6990f6ecbb7e30da6003">ucol_openBinary</a> (const uint8_t *bin, int32_t length, const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *base, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a467ea0dde69a6990f6ecbb7e30da6003"><td class="mdescLeft"> </td><td class="mdescRight">Opens a collator from a collator binary image created using ucol_cloneBinary. <a href="#a467ea0dde69a6990f6ecbb7e30da6003">More...</a><br/></td></tr>
<tr class="separator:a467ea0dde69a6990f6ecbb7e30da6003"><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: Collator. </p>
<h2>Collator C API </h2>
<p>The C API for Collator performs locale-sensitive string comparison. You use this service to build searching and sorting routines for natural language text. </p>
<p>For more information about the collation service see <a href="http://userguide.icu-project.org/collation">the User Guide</a>. </p>
<p>Collation service provides correct sorting orders for most locales supported in ICU. If specific data for a locale is not available, the orders eventually falls back to the <a href="http://www.unicode.org/reports/tr35/tr35-collation.html#Root_Collation">CLDR root sort order</a>. </p>
<p>Sort ordering may be customized by providing your own set of rules. For more on this subject see the <a href="http://userguide.icu-project.org/collation/customization">Collation Customization</a> section of the User Guide. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d" title="UCOL_LESS is returned if source string is compared to be less than target string in the ucol_strcoll(...">UCollationResult</a> </dd>
<dd>
<a class="el" href="unorm_8h.html#af317e3ace13f0ce7c86dd1ca48490ef7" title="Constants for normalization modes. ">UNormalizationMode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a6a967f36248b0a1bc7654f538ee8ba96" title="Base letter represents a primary difference. ">UCollationStrength</a> </dd>
<dd>
<a class="el" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="The UCollationElements struct. ">UCollationElements</a> </dd></dl>
<p>Definition in file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ab8706ece0706f5f3f2b2c3a9797ec01b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_COL_SAFECLONE_BUFFERSIZE   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>default memory size for the new clone. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000263">Deprecated:</a></b></dt><dd>ICU 52. Do not rely on <a class="el" href="ucol_8h.html#a917cd8e16df3b35bbe97dd96d881f227" title="Thread safe cloning operation. ">ucol_safeClone()</a> cloning into any provided buffer. </dd></dl>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l01290">1290</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a6a967f36248b0a1bc7654f538ee8ba96"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Base letter represents a primary difference. </p>
<p>Set comparison level to UCOL_PRIMARY to ignore secondary and tertiary differences. Use this to set the strength of a Collator object. Example of primary difference, "abc" < "abd"</p>
<p>Diacritical differences on the same base letter represent a secondary difference. Set comparison level to UCOL_SECONDARY to ignore tertiary differences. Use this to set the strength of a Collator object. Example of secondary difference, "&auml;" >> "a".</p>
<p>Uppercase and lowercase versions of the same character represents a tertiary difference. Set comparison level to UCOL_TERTIARY to include all comparison differences. Use this to set the strength of a Collator object. Example of tertiary difference, "abc" <<< "ABC".</p>
<p>Two characters are considered "identical" when they have the same unicode spellings. UCOL_IDENTICAL. For example, "&auml;" == "&auml;".</p>
<p>UCollationStrength is also used to determine the strength of sort keys generated from UCollator objects These values can be now found in the UColAttributeValue enum. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004516">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00228">228</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3c4eeb412a5fd72762e6245aa75ca081"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>structure representing a collator object instance </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004512">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00056">56</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attributes that collation service understands. </p>
<p>All the attributes can take UCOL_DEFAULT value, as well as the values specific to each one. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004517">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca580844224ecd5721b5bf4716426a268a"></a>UCOL_FRENCH_COLLATION</em> </td><td class="fielddoc">
<p>Attribute for direction of secondary weights - used in Canadian French. </p>
<p>Acceptable values are UCOL_ON, which results in secondary weights being considered backwards and UCOL_OFF which treats secondary weights in the order they appear. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004572">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826cae979ae2dd00543d6ac89936fcc500f54"></a>UCOL_ALTERNATE_HANDLING</em> </td><td class="fielddoc">
<p>Attribute for handling variable elements. </p>
<p>Acceptable values are UCOL_NON_IGNORABLE (default) which treats all the codepoints with non-ignorable primary weights in the same way, and UCOL_SHIFTED which causes codepoints with primary weights that are equal or below the variable top value to be ignored on primary level and moved to the quaternary level. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004573">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca04e048554399e8d90e0f84ab8a059c97"></a>UCOL_CASE_FIRST</em> </td><td class="fielddoc">
<p>Controls the ordering of upper and lower case letters. </p>
<p>Acceptable values are UCOL_OFF (default), which orders upper and lower case letters in accordance to their tertiary weights, UCOL_UPPER_FIRST which forces upper case letters to sort before lower case letters, and UCOL_LOWER_FIRST which does the opposite. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004574">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca5439a6821b5e3b9de592098dabef1f4e"></a>UCOL_CASE_LEVEL</em> </td><td class="fielddoc">
<p>Controls whether an extra case level (positioned before the third level) is generated or not. </p>
<p>Acceptable values are UCOL_OFF (default), when case level is not generated, and UCOL_ON which causes the case level to be generated. Contents of the case level are affected by the value of UCOL_CASE_FIRST attribute. A simple way to ignore accent differences in a string is to set the strength to UCOL_PRIMARY and enable case level. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004575">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826caef5f0957c1d75026720fe4e1fafabc51"></a>UCOL_NORMALIZATION_MODE</em> </td><td class="fielddoc">
<p>Controls whether the normalization check and necessary normalizations are performed. </p>
<p>When set to UCOL_OFF (default) no normalization check is performed. The correctness of the result is guaranteed only if the input data is in so-called FCD form (see users manual for more info). When set to UCOL_ON, an incremental check is performed to see whether the input data is in the FCD form. If the data is not in the FCD form, incremental NFD normalization is performed. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004576">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca62a765fae5bc78a300665939f3770803"></a>UCOL_DECOMPOSITION_MODE</em> </td><td class="fielddoc">
<p>An alias for UCOL_NORMALIZATION_MODE attribute. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004577">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca46616a060f4d1d81196f27b51ef5f9ff"></a>UCOL_STRENGTH</em> </td><td class="fielddoc">
<p>The strength attribute. </p>
<p>Can be either UCOL_PRIMARY, UCOL_SECONDARY, UCOL_TERTIARY, UCOL_QUATERNARY or UCOL_IDENTICAL. The usual strength for most locales (except Japanese) is tertiary.</p>
<p>Quaternary strength is useful when combined with shifted setting for alternate handling attribute and for JIS X 4061 collation, when it is used to distinguish between Katakana and Hiragana. Otherwise, quaternary level is affected only by the number of non-ignorable code points in the string.</p>
<p>Identical strength is rarely useful, as it amounts to codepoints of the NFD form of the string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004578">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca60b94665bb1469bfed55543e3e9e3651"></a>UCOL_HIRAGANA_QUATERNARY_MODE</em> </td><td class="fielddoc">
<p>When turned on, this attribute positions Hiragana before all non-ignorables on quaternary level This is a sneaky way to produce JIS sort order. </p>
<p>This attribute was an implementation detail of the CLDR Japanese tailoring. Since ICU 50, this attribute is not settable any more via API functions. Since CLDR 25/ICU 53, explicit quaternary relations are used to achieve the same Japanese sort order.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000265">Deprecated:</a></b></dt><dd>ICU 50 Implementation detail, cannot be set via API, was removed from implementation. </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca2efca83794416797ef04abda570c6f5b"></a>UCOL_NUMERIC_COLLATION</em> </td><td class="fielddoc">
<p>When turned on, this attribute makes substrings of digits sort according to their numeric values. </p>
<p>This is a way to get '100' to sort AFTER '2'. Note that the longest digit substring that can be treated as a single unit is 254 digits (not counting leading zeros). If a digit substring is longer than that, the digits beyond the limit will be treated as a separate digit substring.</p>
<p>A "digit" in this sense is a code point with General_Category=Nd, which does not include circled numbers, roman numerals, etc. Only a contiguous digit substring is considered, that is, non-negative integers without separators. There is no support for plus/minus signs, decimals, exponents, etc.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004579">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a583fbe7fc4a850e2fcc692e766d2826ca9b2d19cbeac7a64b3d0354046a3c2fa0"></a>UCOL_ATTRIBUTE_COUNT</em> </td><td class="fielddoc">
<p>The number of UColAttribute constants. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004580">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00234">234</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="acc801048729e684bcabed328be85f77a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum containing attribute values for controling collation behavior. </p>
<p>Here are all the allowable values. Not every attribute can take every value. The only universal value is UCOL_DEFAULT, which resets the attribute value to the predefined value for that locale </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004514">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa4463bb61ef754d062635567e42561a06"></a>UCOL_DEFAULT</em> </td><td class="fielddoc">
<p>accepted by most attributes </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aab304299c75f57c98a7d7de36e226c36e"></a>UCOL_PRIMARY</em> </td><td class="fielddoc">
<p>Primary collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aac4748251d9391c813bec59234e74efb6"></a>UCOL_SECONDARY</em> </td><td class="fielddoc">
<p>Secondary collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa3723e1767f0718b1a74a9dfdabd9de77"></a>UCOL_TERTIARY</em> </td><td class="fielddoc">
<p>Tertiary collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aafd51e6b6d3a6930fa57e96f5352ecb34"></a>UCOL_DEFAULT_STRENGTH</em> </td><td class="fielddoc">
<p>Default collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa8a79d0941ea478c1360bd590748c9f41"></a>UCOL_QUATERNARY</em> </td><td class="fielddoc">
<p>Quaternary collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa506f0c7653777a4b344f7a5f633af26c"></a>UCOL_IDENTICAL</em> </td><td class="fielddoc">
<p>Identical collation strength. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa798c0f324ab1a796c44fc1ac5961580d"></a>UCOL_OFF</em> </td><td class="fielddoc">
<p>Turn the feature off - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MODE & UCOL_DECOMPOSITION_MODE. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aad6c6d3813dc17544960944d861893ed5"></a>UCOL_ON</em> </td><td class="fielddoc">
<p>Turn the feature on - works for UCOL_FRENCH_COLLATION, UCOL_CASE_LEVEL, UCOL_HIRAGANA_QUATERNARY_MODE & UCOL_DECOMPOSITION_MODE. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa9d8c0e91ba648450330ca9dcb4d00079"></a>UCOL_SHIFTED</em> </td><td class="fielddoc">
<p>Valid for UCOL_ALTERNATE_HANDLING. </p>
<p>Alternate handling will be shifted </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aac90c0ea41c9c79eeb0054060b4f598dd"></a>UCOL_NON_IGNORABLE</em> </td><td class="fielddoc">
<p>Valid for UCOL_ALTERNATE_HANDLING. </p>
<p>Alternate handling will be non ignorable </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aab81cb97ed24b4d28dff15521e74d3000"></a>UCOL_LOWER_FIRST</em> </td><td class="fielddoc">
<p>Valid for UCOL_CASE_FIRST - lower case sorts before upper case. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acc801048729e684bcabed328be85f77aa20c4404d3b43e984d3afecfed7fbf3ea"></a>UCOL_UPPER_FIRST</em> </td><td class="fielddoc">
<p>upper case sorts before lower case </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00087">87</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa3b11e0e399df62d3048174b8309657c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>enum that is taken by ucol_getBound API See below for explanation do not change the values assigned to the members of this enum. </p>
<p>Underlying code depends on them having these numbers </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004548">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aa3b11e0e399df62d3048174b8309657ca07971cd4fb76b1ac281462f5b2a70fd5"></a>UCOL_BOUND_LOWER</em> </td><td class="fielddoc">
<p>lower bound </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aa3b11e0e399df62d3048174b8309657ca398433c7f3d342924c2cc3d537dd75ce"></a>UCOL_BOUND_UPPER</em> </td><td class="fielddoc">
<p>upper bound that will match strings of exact size </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aa3b11e0e399df62d3048174b8309657cab3acc199e3c1c44251a2b7f2d13633a6"></a>UCOL_BOUND_UPPER_LONG</em> </td><td class="fielddoc">
<p>upper bound that will match all the strings that have the same initial substring as the given string </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l01023">1023</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8b4e71db8109af87f84ac1576e2b245d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>UCOL_LESS is returned if source string is compared to be less than target string in the <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll()</a> method. </p>
<p>UCOL_EQUAL is returned if source string is compared to be equal to target string in the <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll()</a> method. UCOL_GREATER is returned if source string is compared to be greater than target string in the <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll()</a> method. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll()</a> </dd></dl>
<p>Possible values for a comparison result </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004513">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a8b4e71db8109af87f84ac1576e2b245dad62021a93c87f18e7d7400aeae76afbe"></a>UCOL_EQUAL</em> </td><td class="fielddoc">
<p>string a == string b </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a8b4e71db8109af87f84ac1576e2b245dab077d467fc9b8d2f5cdebdf04e9912ae"></a>UCOL_GREATER</em> </td><td class="fielddoc">
<p>string a > string b </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a8b4e71db8109af87f84ac1576e2b245da3ff43a44b34460a1ca53bbe88b35a624"></a>UCOL_LESS</em> </td><td class="fielddoc">
<p>string a < string b </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00071">71</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae491f1262ff311f19e74830eb685f887"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum containing the codes for reordering segments of the collation table that are not script codes. </p>
<p>These reordering codes are to be used in conjunction with the script codes. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a6e3ad662b7141615599dbe11c3c0e328" title="Retrieves the reordering codes for this collator. ">ucol_getReorderCodes</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a3d52959dc92e90d2bccc800fab679e65" title="Retrieves the reorder codes that are grouped with the given reorder code. ">ucol_getEquivalentReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004515">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a21f7a26a846970611988c3bd5540e292"></a>UCOL_REORDER_CODE_DEFAULT</em> </td><td class="fielddoc">
<p>A special reordering code that is used to specify the default reordering codes for a locale. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004562">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a18077893b37324c1d5753c60a437d9b4"></a>UCOL_REORDER_CODE_NONE</em> </td><td class="fielddoc">
<p>A special reordering code that is used to specify no reordering codes. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004563">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a1053091a40da5ad91fca2530e17e5f45"></a>UCOL_REORDER_CODE_OTHERS</em> </td><td class="fielddoc">
<p>A special reordering code that is used to specify all other codes used for reordering except for the codes lised as UColReorderCode values and those listed explicitly in a reordering. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004564">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a961b335efb535ce3b480c927a82cfd8e"></a>UCOL_REORDER_CODE_SPACE</em> </td><td class="fielddoc">
<p>Characters with the space property. </p>
<p>This is equivalent to the rule value "space". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004565">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887ac1cdea67134c7f0815454cf0e4914b53"></a>UCOL_REORDER_CODE_FIRST</em> </td><td class="fielddoc">
<p>The first entry in the enumeration of reordering groups. </p>
<p>This is intended for use in range checking and enumeration of the reorder codes. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004566">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a7403925d0681a31ae6548ff12308d8fe"></a>UCOL_REORDER_CODE_PUNCTUATION</em> </td><td class="fielddoc">
<p>Characters with the punctuation property. </p>
<p>This is equivalent to the rule value "punct". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004567">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a46e6d81b83777db4bf754fa8175533ab"></a>UCOL_REORDER_CODE_SYMBOL</em> </td><td class="fielddoc">
<p>Characters with the symbol property. </p>
<p>This is equivalent to the rule value "symbol". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004568">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887ae2dd17d6e761e782a4c3131e89a4fa24"></a>UCOL_REORDER_CODE_CURRENCY</em> </td><td class="fielddoc">
<p>Characters with the currency property. </p>
<p>This is equivalent to the rule value "currency". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004569">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a574ecd4c743af4bc92c4316462bd9e26"></a>UCOL_REORDER_CODE_DIGIT</em> </td><td class="fielddoc">
<p>Characters with the digit property. </p>
<p>This is equivalent to the rule value "digit". </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004570">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="ae491f1262ff311f19e74830eb685f887a33a969251c0d8437609c6cdd40c11da3"></a>UCOL_REORDER_CODE_LIMIT</em> </td><td class="fielddoc">
<p>The limit of the reorder codes. </p>
<p>This is intended for use in range checking and enumeration of the reorder codes. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004571">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00139">139</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<a class="anchor" id="a46363290036b8dffd6862c35e7b5872f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Options for retrieving the rule string. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004518">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a46363290036b8dffd6862c35e7b5872fac2d59cd7a59b9be9fe1b38dc4de593f7"></a>UCOL_TAILORING_ONLY</em> </td><td class="fielddoc">
<p>Retrieves the tailoring rules only. </p>
<p>Same as calling the version of getRules() without UColRuleOption. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004581">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a46363290036b8dffd6862c35e7b5872fa6e027e190a33aa58b026afd48a97b67f"></a>UCOL_FULL_RULES</em> </td><td class="fielddoc">
<p>Retrieves the "UCA rules" concatenated with the tailoring rules. </p>
<p>The "UCA rules" are an <em>approximation</em> of the root collator's sort order. They are almost never used or useful at runtime and can be removed from the data. See <a href="http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales">http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales</a> </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004582">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="ucol_8h_source.html#l00346">346</a> of file <a class="el" href="ucol_8h_source.html">ucol.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a2719995a75ebed7aacc1419bb2b781db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_cloneBinary </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">uint8_t * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</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>Creates a binary image of a collator. </p>
<p>This binary image can be stored and later used to instantiate a collator using ucol_openBinary. This API supports preflighting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>Collator </td></tr>
<tr><td class="paramname">buffer</td><td>a fill-in buffer to receive the binary image </td></tr>
<tr><td class="paramname">capacity</td><td>capacity of the destination buffer </td></tr>
<tr><td class="paramname">status</td><td>for catching errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the image </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a467ea0dde69a6990f6ecbb7e30da6003" title="Opens a collator from a collator binary image created using ucol_cloneBinary. ">ucol_openBinary</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004560">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a68fce4fae47371bfece8a288ef05f11f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>coll</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a UCollator. </p>
<p>Once closed, a UCollator should not be used. Every open collator should be closed. Otherwise, a memory leak will result. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to close. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a4721e4c0a519bb0139a874e191223590" title="Open a UCollator for comparing strings. ">ucol_open</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#aa128ea0ed3869415c1c96a9a2c997c2d" title="Produce a UCollator instance according to the rules supplied. ">ucol_openRules</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a917cd8e16df3b35bbe97dd96d881f227" title="Thread safe cloning operation. ">ucol_safeClone</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004523">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="abd3f9bd0c933c74cb36723f524c91d19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_countAvailable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine how many locales have collation rules available. </p>
<p>This function is most useful as determining the loop ending condition for calls to <a class="el" href="ucol_8h.html#a0e375872b21ab6286258638dcf3817c0">ucol_getAvailable</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of locales for which collation rules are available. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a0e375872b21ab6286258638dcf3817c0" title="Get a locale for which collation rules are available. ">ucol_getAvailable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004537">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad592bf65b8b5859ea06ab565f0e6e869"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucol_equal </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>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</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>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare two strings for equality. </p>
<p>This function is equivalent to <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694">ucol_strcoll</a> == UCOL_EQUAL </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">source</td><td>The source string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>The target string. </td></tr>
<tr><td class="paramname">targetLength</td><td>The length of target, or -1 if null-terminated. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if source is equal to target, FALSE otherwise </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#aa9eb676fde40581f43cc7eb24b597e0e" title="Determine if one string is greater than another. ">ucol_greater</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad04f5b8001a319c71f1dc2da06519091" title="Determine if one string is greater than or equal to another. ">ucol_greaterOrEqual</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004528">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af96cc7dc7da7981d2d12356b104e058a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> ucol_getAttribute </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"><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> </td>
<td class="paramname"><em>attr</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>Universal attribute getter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator which attributes are to be changed </td></tr>
<tr><td class="paramname">attr</td><td>attribute type </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>attribute value </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c" title="Attributes that collation service understands. ">UColAttribute</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a" title="Enum containing attribute values for controling collation behavior. ">UColAttributeValue</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a3a2302e315d5b474f94354cffedeecd7" title="Universal attribute setter. ">ucol_setAttribute</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004554">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0e375872b21ab6286258638dcf3817c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucol_getAvailable </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>localeIndex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a locale for which collation rules are available. </p>
<p>A UCollator in a locale returned by this function will perform the correct collation for the locale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">localeIndex</td><td>The index of the desired locale. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A locale for which collation rules are available, or 0 if none. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#abd3f9bd0c933c74cb36723f524c91d19" title="Determine how many locales have collation rules available. ">ucol_countAvailable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004536">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="acbaf099e596089c777f297a39d2af753"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getBound </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#aa3b11e0e399df62d3048174b8309657c">UColBoundMode</a> </td>
<td class="paramname"><em>boundType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>noOfLevels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</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>Produce a bound for a given sortkey and a number of levels. </p>
<p>Return value is always the number of bytes needed, regardless of whether the result buffer was big enough or even valid.<br/>
Resulting bounds can be used to produce a range of strings that are between upper and lower bounds. For example, if bounds are produced for a sortkey of string "smith", strings between upper and lower bounds with one level would include "Smith", "SMITH", "sMiTh".<br/>
There are two upper bounds that can be produced. If UCOL_BOUND_UPPER is produced, strings matched would be as above. However, if bound produced using UCOL_BOUND_UPPER_LONG is used, the above example will also match "Smithsonian" and similar.<br/>
For more on usage, see example in cintltst/capitst.c in procedure TestBounds. Sort keys may be compared using <code>strcmp</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>The source sortkey. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. (If an unmodified sortkey is passed, it is always null terminated). </td></tr>
<tr><td class="paramname">boundType</td><td>Type of bound required. It can be UCOL_BOUND_LOWER, which produces a lower inclusive bound, UCOL_BOUND_UPPER, that produces upper bound that matches strings of the same length or UCOL_BOUND_UPPER_LONG that matches strings that have the same starting substring as the source string. </td></tr>
<tr><td class="paramname">noOfLevels</td><td>Number of levels required in the resulting bound (for most uses, the recommended value is 1). See users guide for explanation on number of levels a sortkey can have. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the resulting sortkey. </td></tr>
<tr><td class="paramname">resultLength</td><td>The maximum size of result. </td></tr>
<tr><td class="paramname">status</td><td>Used for returning error code if something went wrong. If the number of levels requested is higher than the number of levels in the source key, a warning (U_SORT_KEY_TOO_SHORT_WARNING) is issued. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The size needed to fully store the bound. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucoleitr_8h.html#a705331b3ca250e3f5f74accfee861fa4" title="get a hash code for a key... ">ucol_keyHashCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004549">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="a60a1437827161a2f33a4dd44e27ef02a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getContractions </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"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>conts</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 a set containing the contractions defined by the collator. </p>
<p>The set includes both the root collator's contractions and the contractions defined by the collator. This set will contain only strings. If a tailoring explicitly suppresses contractions from the root collator (like Russian), removed contractions will not be in the resulting set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator </td></tr>
<tr><td class="paramname">conts</td><td>the set to hold the result. It gets emptied before contractions are added. </td></tr>
<tr><td class="paramname">status</td><td>to hold the error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the size of the contraction set</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000260">Deprecated:</a></b></dt><dd>ICU 3.4, use ucol_getContractionsAndExpansions instead </dd></dl>
</div>
</div>
<a class="anchor" id="a395afb2b873efee82430ac0ab2388250"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_getContractionsAndExpansions </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"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>contractions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>expansions</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>addPrefixes</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 a set containing the expansions defined by the collator. </p>
<p>The set includes both the root collator's expansions and the expansions defined by the tailoring </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator </td></tr>
<tr><td class="paramname">contractions</td><td>if not NULL, the set to hold the contractions </td></tr>
<tr><td class="paramname">expansions</td><td>if not NULL, the set to hold the expansions </td></tr>
<tr><td class="paramname">addPrefixes</td><td>add the prefix contextual elements to contractions </td></tr>
<tr><td class="paramname">status</td><td>to hold the error code</td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004522">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aa29f34789ceeada3021c1219c93d7653"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getDisplayName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>objLoc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dispLoc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</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 display name for a UCollator. </p>
<p>The display name is suitable for presentation to a user. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objLoc</td><td>The locale of the collator in question. </td></tr>
<tr><td class="paramname">dispLoc</td><td>The locale for display. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the attribute. </td></tr>
<tr><td class="paramname">resultLength</td><td>The maximum size of result. </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 total buffer size needed; if greater than resultLength, the output was truncated. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004535">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a3d52959dc92e90d2bccc800fab679e65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getEquivalentReorderCodes </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>reorderCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</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>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reorder codes that are grouped with the given reorder code. </p>
<p>Some reorder codes will be grouped and must reorder together. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reorderCode</td><td>The reorder code to determine equivalence for. </td></tr>
<tr><td class="paramname">dest</td><td>The array to fill with the script ordering. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting). </td></tr>
<tr><td class="paramname">pErrorCode</td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of reordering codes written to the dest array. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a6e3ad662b7141615599dbe11c3c0e328" title="Retrieves the reordering codes for this collator. ">ucol_getReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004534">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="af8d6d6df31c7fad5a4f93cc8beb6eeaf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getFunctionalEquivalent </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>keyword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> * </td>
<td class="paramname"><em>isAvailable</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>Return the functionally equivalent locale for the given requested locale, with respect to given keyword, for the collation service. </p>
<p>If two locales return the same result, then collators instantiated for these locales will behave equivalently. The converse is not always true; two collators may in fact be equivalent, but return different results, due to internal details. The return result has no other meaning than that stated above, and implies nothing as to the relationship between the two locales. This is intended for use by applications who wish to cache collators, or otherwise reuse collators when possible. The functional equivalent may change over time. For more information, please see the <a href="http://userguide.icu-project.org/locale#TOC-Locales-and-Services">Locales and Services</a> section of the ICU User Guide. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>fillin for the functionally equivalent locale </td></tr>
<tr><td class="paramname">resultCapacity</td><td>capacity of the fillin buffer </td></tr>
<tr><td class="paramname">keyword</td><td>a particular keyword as enumerated by ucol_getKeywords. </td></tr>
<tr><td class="paramname">locale</td><td>the requested locale </td></tr>
<tr><td class="paramname">isAvailable</td><td>if non-NULL, pointer to a fillin parameter that indicates whether the requested locale was 'available' to the collation service. A locale is defined as 'available' if it physically exists within the collation locale data. </td></tr>
<tr><td class="paramname">status</td><td>pointer to input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the actual buffer size needed for the locale. If greater than resultCapacity, the returned full name will be truncated and an error code will be returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004542">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5a8d9b9578d6238395ddb748e2ebe1dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucol_getKeywords </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string enumerator of all possible keywords that are relevant to collation. </p>
<p>At this point, the only recognized keyword for this service is "collation". </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over locale strings. The caller is responsible for closing the result. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004539">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1a647734f3924283c92f6fbbafcc40eb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucol_getKeywordValues </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>keyword</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>Given a keyword, create a string enumeration of all values for that keyword that are currently in use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyword</td><td>a particular keyword as enumerated by ucol_getKeywords. If any other keyword is passed in, *status is set to U_ILLEGAL_ARGUMENT_ERROR. </td></tr>
<tr><td class="paramname">status</td><td>input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over collation keyword values, or NULL upon error. The caller is responsible for closing the result. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004540">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a2b188d4076f7603844bb7896f1cc0e43"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucol_getKeywordValuesForLocale </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>commonlyUsed</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>Given a key and a locale, returns an array of string values in a preferred order that would make a difference. </p>
<p>These are all and only those values where the open (creation) of the service with the locale formed from the input locale plus input keyword and that value has different behavior than creation with the input locale alone. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>one of the keys supported by this service. For now, only "collation" is supported. </td></tr>
<tr><td class="paramname">locale</td><td>the locale </td></tr>
<tr><td class="paramname">commonlyUsed</td><td>if set to true it will return only commonly used values with the given locale in preferred order. Otherwise, it will return all the available values for the locale. </td></tr>
<tr><td class="paramname">status</td><td>error status </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over keyword values for the given key and the locale. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004541">Stable:</a></b></dt><dd>ICU 4.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a9df9e4a23459301d723f16600ca2a7b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucol_getLocale </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"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"><em>type</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>gets the locale name of the collator. </p>
<p>If the collator is instantiated from the rules, then this function returns NULL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator for which the locale is needed </td></tr>
<tr><td class="paramname">type</td><td>You can choose between requested, valid and actual locale. For description see the definition of ULocDataLocaleType in <a class="el" href="uloc_8h.html" title="C API: Locale. ">uloc.h</a> </td></tr>
<tr><td class="paramname">status</td><td>error code of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>real locale name from which the collation data comes. If the collator was instantiated from rules, returns NULL. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000264">Deprecated:</a></b></dt><dd>ICU 2.8 Use ucol_getLocaleByType instead </dd></dl>
</div>
</div>
<a class="anchor" id="ade40592efde5935d3c0cd6f940d4c2e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucol_getLocaleByType </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"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"><em>type</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>gets the locale name of the collator. </p>
<p>If the collator is instantiated from the rules, then this function returns NULL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator for which the locale is needed </td></tr>
<tr><td class="paramname">type</td><td>You can choose between requested, valid and actual locale. For description see the definition of ULocDataLocaleType in <a class="el" href="uloc_8h.html" title="C API: Locale. ">uloc.h</a> </td></tr>
<tr><td class="paramname">status</td><td>error code of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>real locale name from which the collation data comes. If the collator was instantiated from rules, returns NULL. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004558">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a15526321f50d1b424e659e3726a5ece4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> ucol_getMaxVariable </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>the collator </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the maximum variable reordering group. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable</a> </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000154">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 53 </dd></dl>
</div>
</div>
<a class="anchor" id="a6e3ad662b7141615599dbe11c3c0e328"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getReorderCodes </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">int32_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</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>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reordering codes for this collator. </p>
<p>These reordering codes are a combination of UScript codes and UColReorderCode entries. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to query. </td></tr>
<tr><td class="paramname">dest</td><td>The array to fill with the script ordering. </td></tr>
<tr><td class="paramname">destCapacity</td><td>The length of dest. If it is 0, then dest may be NULL and the function will only return the length of the result without writing any of the result string (pre-flighting). </td></tr>
<tr><td class="paramname">pErrorCode</td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of reordering codes written to the dest array. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a7473236c4a96983fc1c53c9ab566c2e3" title="Sets the reordering codes for this collator. ">ucol_setReorderCodes</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a3d52959dc92e90d2bccc800fab679e65" title="Retrieves the reorder codes that are grouped with the given reorder code. ">ucol_getEquivalentReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004532">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a8085a8ab866292a6ff92720b861aa5a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ucol_getRules </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">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 the collation tailoring rules from a UCollator. </p>
<p>The rules will follow the rule syntax. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to query. </td></tr>
<tr><td class="paramname">length</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The collation tailoring rules. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004543">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a318cfd0bef6d92a7aab8bef55a4e1bf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getRulesEx </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"><a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872f">UColRuleOption</a> </td>
<td class="paramname"><em>delta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>bufferLen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns current rules. </p>
<p>Delta defines whether full rules are returned or just the tailoring. Returns number of UChars needed to store rules. If buffer is NULL or bufferLen is not enough to store rules, will store up to available space.</p>
<p><a class="el" href="ucol_8h.html#a8085a8ab866292a6ff92720b861aa5a6" title="Get the collation tailoring rules from a UCollator. ">ucol_getRules()</a> should normally be used instead. See <a href="http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales">http://userguide.icu-project.org/collation/customization#TOC-Building-on-Existing-Locales</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator to get the rules from </td></tr>
<tr><td class="paramname">delta</td><td>one of UCOL_TAILORING_ONLY, UCOL_FULL_RULES. </td></tr>
<tr><td class="paramname">buffer</td><td>buffer to store the result in. If NULL, you'll get no rules. </td></tr>
<tr><td class="paramname">bufferLen</td><td>length of buffer to store rules in. If less than needed you'll get only the part that fits in. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current rules </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004557">Stable:</a></b></dt><dd>ICU 2.0 <dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a46363290036b8dffd6862c35e7b5872fa6e027e190a33aa58b026afd48a97b67f" title="Retrieves the "UCA rules" concatenated with the tailoring rules. ">UCOL_FULL_RULES</a> </dd></dl>
</dd></dl>
</div>
</div>
<a class="anchor" id="a762daeafd0df7cc65fd120a1e802cbbe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getShortDefinitionString </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 char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</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 short definition string for a collator. </p>
<p>This API harvests the collator's locale and the attribute set and produces a string that can be used for opening a collator with the same attributes using the ucol_openFromShortString API. This string will be normalized. The structure and the syntax of the string is defined in the "Naming collators" section of the users guide: <a href="http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme">http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme</a> This API supports preflighting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>a collator </td></tr>
<tr><td class="paramname">locale</td><td>a locale that will appear as a collators locale in the resulting short string definition. If NULL, the locale will be harvested from the collator. </td></tr>
<tr><td class="paramname">buffer</td><td>space to hold the resulting string </td></tr>
<tr><td class="paramname">capacity</td><td>capacity of the buffer </td></tr>
<tr><td class="paramname">status</td><td>for returning errors. All the preflighting errors are featured </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>length of the resulting string </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a39ccd61fb814dc0d2e759bc0cfe4c80d" title="Open a collator defined by a short form string. ">ucol_openFromShortString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a4527a9eefdd7e071fff9d87b2e418cfa" title="Verifies and normalizes short definition string. ">ucol_normalizeShortDefinitionString</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004544">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1f83f9c96a0950e2c22bd5c5c31ff6bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getSortKey </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>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a sort key for a string from a UCollator. </p>
<p>Sort keys may be compared using <code>strcmp</code>.</p>
<p>Like ICU functions that write to an output buffer, the buffer contents is undefined if the buffer capacity (resultLength parameter) is too small. Unlike ICU functions that write a string to an output buffer, the terminating zero byte is counted in the sort key length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the collation rules. </td></tr>
<tr><td class="paramname">source</td><td>The string to transform. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the attribute. </td></tr>
<tr><td class="paramname">resultLength</td><td>The maximum size of result. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The size needed to fully store the sort key. If there was an internal error generating the sort key, a zero value is returned. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucoleitr_8h.html#a705331b3ca250e3f5f74accfee861fa4" title="get a hash code for a key... ">ucol_keyHashCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004546">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="abc4eaea4396300af64c5891fc6c4c0a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> ucol_getStrength </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><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the collation strength used in a UCollator. </p>
<p>The strength influences how strings are compared. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to query. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The collation strength; one of UCOL_PRIMARY, UCOL_SECONDARY, UCOL_TERTIARY, UCOL_QUATERNARY, UCOL_IDENTICAL </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#adcbb3eee538142a06a89e066400dd9b7" title="Set the collation strength used in a UCollator. ">ucol_setStrength</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004530">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1982f184bca8adaa848144a1959ff235"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a>* ucol_getTailoredSet </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"><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 a Unicode set that contains all the characters and sequences tailored in this collator. </p>
<p>The result must be disposed of by using uset_close. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator for which we want to get tailored chars </td></tr>
<tr><td class="paramname">status</td><td>error code of the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to newly created USet. Must be be disposed by using uset_close </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa128ea0ed3869415c1c96a9a2c997c2d" title="Produce a UCollator instance according to the rules supplied. ">ucol_openRules</a> </dd>
<dd>
<a class="el" href="uset_8h.html#abb0d0fb8d660204fd7fef7fe920bb70c" title="Disposes of the storage used by a USet object. ">uset_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004559">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a0c83c7005da2dbb920437165d6248ce5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_getUCAVersion </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"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the UCA version information for a Collator. </p>
<p>Version is the UCA version number (3.1.1, 4.0). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to query. </td></tr>
<tr><td class="paramname">info</td><td>the version # information, the result will be filled in </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004551">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a05602ef69e9303eab4f27f082da78cdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_getUnsafeSet </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"><a class="el" href="ucnv_8h.html#adce3fef7c15d7c78196bf977ac96ec9c">USet</a> * </td>
<td class="paramname"><em>unsafe</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>Calculates the set of unsafe code points, given a collator. </p>
<p>A character is unsafe if you could append any character and cause the ordering to alter significantly. Collation sorts in normalized order, so anything that rearranges in normalization can cause this. Thus if you have a character like a_umlaut, and you add a lower_dot to it, then it normalizes to a_lower_dot + umlaut, and sorts differently. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>Collator </td></tr>
<tr><td class="paramname">unsafe</td><td>a fill-in set to receive the unsafe points </td></tr>
<tr><td class="paramname">status</td><td>for catching errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of elements in the set </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000436">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a802cc1a4f7f3e9de7089802294377867"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ucol_getVariableTop </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"><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>Gets the variable top value of a Collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator which variable top needs to be retrieved </td></tr>
<tr><td class="paramname">status</td><td>error code (not changed by function). If error code is set, the return value is undefined. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the variable top primary weight </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a15526321f50d1b424e659e3726a5ece4" title="Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. ">ucol_getMaxVariable</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a0e9c28a8b8b88890722daca111207688" title="Sets the variable top to the primary weight of the specified string. ">ucol_setVariableTop</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad10de03e206f2b9dceb59b59e75bc7d8" title="Sets the variable top to the specified primary weight. ">ucol_restoreVariableTop</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004555">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af756972781ac556a62e48cbd509ea4a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_getVersion </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"><a class="el" href="uversion_8h.html#a61caef96ba86d8e86a4031925ea44e94">UVersionInfo</a> </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the version information for a Collator. </p>
<p>Version is currently an opaque 32-bit number which depends, among other things, on major versions of the collator tailoring and UCA. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to query. </td></tr>
<tr><td class="paramname">info</td><td>the version # information, the result will be filled in </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004550">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aa9eb676fde40581f43cc7eb24b597e0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucol_greater </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>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</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>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if one string is greater than another. </p>
<p>This function is equivalent to <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694">ucol_strcoll</a> == UCOL_GREATER </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">source</td><td>The source string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>The target string. </td></tr>
<tr><td class="paramname">targetLength</td><td>The length of target, or -1 if null-terminated. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if source is greater than target, FALSE otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad04f5b8001a319c71f1dc2da06519091" title="Determine if one string is greater than or equal to another. ">ucol_greaterOrEqual</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad592bf65b8b5859ea06ab565f0e6e869" title="Compare two strings for equality. ">ucol_equal</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004526">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad04f5b8001a319c71f1dc2da06519091"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucol_greaterOrEqual </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>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</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>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if one string is greater than or equal to another. </p>
<p>This function is equivalent to <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694">ucol_strcoll</a> != UCOL_LESS </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">source</td><td>The source string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>The target string. </td></tr>
<tr><td class="paramname">targetLength</td><td>The length of target, or -1 if null-terminated. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if source is greater than or equal to target, FALSE otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#aa9eb676fde40581f43cc7eb24b597e0e" title="Determine if one string is greater than another. ">ucol_greater</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad592bf65b8b5859ea06ab565f0e6e869" title="Compare two strings for equality. ">ucol_equal</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004527">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a18de00ad7c0da5b2f23dfa5facdc3901"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_mergeSortkeys </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>src1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>src1Length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>src2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>src2Length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>destCapacity</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Merges two sort keys. </p>
<p>The levels are merged with their corresponding counterparts (primaries with primaries, secondaries with secondaries etc.). Between the values from the same level a separator is inserted.</p>
<p>This is useful, for example, for combining sort keys from first and last names to sort such pairs. It is possible to merge multiple sort keys by consecutively merging another one with the intermediate result.</p>
<p>The length of the merge result is the sum of the lengths of the input sort keys.</p>
<p>Example (uncompressed): </p>
<pre>191B1D 01 050505 01 910505 00
1F2123 01 050505 01 910505 00</pre><p> will be merged as </p>
<pre>191B1D 02 1F2123 01 050505 02 050505 01 910505 02 910505 00</pre><p>If the destination buffer is not big enough, then its contents are undefined. If any of source lengths are zero or any of the source pointers are NULL/undefined, the result is of size zero.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src1</td><td>the first sort key </td></tr>
<tr><td class="paramname">src1Length</td><td>the length of the first sort key, including the zero byte at the end; can be -1 if the function is to find the length </td></tr>
<tr><td class="paramname">src2</td><td>the second sort key </td></tr>
<tr><td class="paramname">src2Length</td><td>the length of the second sort key, including the zero byte at the end; can be -1 if the function is to find the length </td></tr>
<tr><td class="paramname">dest</td><td>the buffer where the merged sort key is written, can be NULL if destCapacity==0 </td></tr>
<tr><td class="paramname">destCapacity</td><td>the number of bytes in the dest buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the length of the merged sort key, src1Length+src2Length; can be larger than destCapacity, or 0 if an error occurs (only for illegal arguments), in which cases the contents of dest is undefined </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004552">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a8c8ed92bb13577d6cd9a129b38a05d69"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_nextSortKeyPart </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"><a class="el" href="structUCharIterator.html">UCharIterator</a> * </td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>state</em>[2], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>count</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>Gets the next count bytes of a sort key. </p>
<p>Caller needs to preserve state array between calls and to provide the same type of <a class="el" href="structUCharIterator.html" title="C API for code unit iteration. ">UCharIterator</a> set with the same string. The destination buffer provided must be big enough to store the number of requested bytes.</p>
<p>The generated sort key may or may not be compatible with sort keys generated using <a class="el" href="ucol_8h.html#a1f83f9c96a0950e2c22bd5c5c31ff6bf" title="Get a sort key for a string from a UCollator. ">ucol_getSortKey()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the collation rules. </td></tr>
<tr><td class="paramname">iter</td><td><a class="el" href="structUCharIterator.html" title="C API for code unit iteration. ">UCharIterator</a> containing the string we need the sort key to be calculated for. </td></tr>
<tr><td class="paramname">state</td><td>Opaque state of sortkey iteration. </td></tr>
<tr><td class="paramname">dest</td><td>Buffer to hold the resulting sortkey part </td></tr>
<tr><td class="paramname">count</td><td>number of sort key bytes required. </td></tr>
<tr><td class="paramname">status</td><td>error code indicator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the actual number of bytes of a sortkey. It can be smaller than count if we have reached the end of the sort key. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004547">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a4527a9eefdd7e071fff9d87b2e418cfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ucol_normalizeShortDefinitionString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>destination</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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>Verifies and normalizes short definition string. </p>
<p>Normalized short definition string has all the option sorted by the argument name, so that equivalent definition strings are the same. This API supports preflighting. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source</td><td>definition string </td></tr>
<tr><td class="paramname">destination</td><td>space to hold the resulting string </td></tr>
<tr><td class="paramname">capacity</td><td>capacity of the buffer </td></tr>
<tr><td class="paramname">parseError</td><td>if not NULL, structure that will get filled with error's pre and post context in case of error. </td></tr>
<tr><td class="paramname">status</td><td>Error code. This API will return an error if an invalid attribute or attribute/value combination is specified. All the preflighting errors are also featured </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>length of the resulting normalized string.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a39ccd61fb814dc0d2e759bc0cfe4c80d" title="Open a collator defined by a short form string. ">ucol_openFromShortString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a762daeafd0df7cc65fd120a1e802cbbe" title="Get the short definition string for a collator. ">ucol_getShortDefinitionString</a></dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004545">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a4721e4c0a519bb0139a874e191223590"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* ucol_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>loc</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 a UCollator for comparing strings. </p>
<p>The UCollator pointer is used in all the calls to the Collation service. After finished, collator must be disposed of by calling <a class="el" href="ucol_8h.html#a68fce4fae47371bfece8a288ef05f11f">ucol_close</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc</td><td>The locale containing the required collation rules. Special values for locales can be passed in - if NULL is passed for the locale, the default locale collation rules will be used. If empty string ("") or "root" are passed, the root collator will be returned. </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 pointer to a UCollator, or 0 if an error occurred. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa128ea0ed3869415c1c96a9a2c997c2d" title="Produce a UCollator instance according to the rules supplied. ">ucol_openRules</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a917cd8e16df3b35bbe97dd96d881f227" title="Thread safe cloning operation. ">ucol_safeClone</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a68fce4fae47371bfece8a288ef05f11f" title="Close a UCollator. ">ucol_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004519">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a29eccc8e4136301e7c6b5e295cefda9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* ucol_openAvailableLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a string enumerator of all locales for which a valid collator may be opened. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>input-output error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string enumeration over locale strings. The caller is responsible for closing the result. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004538">Stable:</a></b></dt><dd>ICU 3.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a467ea0dde69a6990f6ecbb7e30da6003"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* ucol_openBinary </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>bin</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 class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td>
<td class="paramname"><em>base</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>Opens a collator from a collator binary image created using ucol_cloneBinary. </p>
<p>Binary image used in instantiation of the collator remains owned by the user and should stay around for the lifetime of the collator. The API also takes a base collator which usually should be the root collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bin</td><td>binary image owned by the user and required through the lifetime of the collator </td></tr>
<tr><td class="paramname">length</td><td>size of the image. If negative, the API will try to figure out the length of the image </td></tr>
<tr><td class="paramname">base</td><td>fallback collator, usually the root collator. Base is required to be present through the lifetime of the collator. Currently it cannot be NULL. </td></tr>
<tr><td class="paramname">status</td><td>for catching errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created collator </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a2719995a75ebed7aacc1419bb2b781db" title="Creates a binary image of a collator. ">ucol_cloneBinary</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004561">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a39ccd61fb814dc0d2e759bc0cfe4c80d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* ucol_openFromShortString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>definition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>forceDefaults</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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 a collator defined by a short form string. </p>
<p>The structure and the syntax of the string is defined in the "Naming collators" section of the users guide: <a href="http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme">http://userguide.icu-project.org/collation/concepts#TOC-Collator-naming-scheme</a> Attributes are overriden by the subsequent attributes. So, for "S2_S3", final strength will be 3. 3066bis locale overrides individual locale parts. The call to this function is equivalent to a call to ucol_open, followed by a series of calls to ucol_setAttribute and ucol_setVariableTop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">definition</td><td>A short string containing a locale and a set of attributes. Attributes not explicitly mentioned are left at the default state for a locale. </td></tr>
<tr><td class="paramname">parseError</td><td>if not NULL, structure that will get filled with error's pre and post context in case of error. </td></tr>
<tr><td class="paramname">forceDefaults</td><td>if FALSE, the settings that are the same as the collator default settings will not be applied (for example, setting French secondary on a French collator would not be executed). If TRUE, all the settings will be applied regardless of the collator default value. If the definition strings are to be cached, should be set to FALSE. </td></tr>
<tr><td class="paramname">status</td><td>Error code. Apart from regular error conditions connected to instantiating collators (like out of memory or similar), this API will return an error if an invalid attribute or attribute/value combination is specified. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a UCollator or 0 if an error occured (including an invalid attribute). </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a4721e4c0a519bb0139a874e191223590" title="Open a UCollator for comparing strings. ">ucol_open</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a3a2302e315d5b474f94354cffedeecd7" title="Universal attribute setter. ">ucol_setAttribute</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a0e9c28a8b8b88890722daca111207688" title="Sets the variable top to the primary weight of the specified string. ">ucol_setVariableTop</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a762daeafd0df7cc65fd120a1e802cbbe" title="Get the short definition string for a collator. ">ucol_getShortDefinitionString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a4527a9eefdd7e071fff9d87b2e418cfa" title="Verifies and normalizes short definition string. ">ucol_normalizeShortDefinitionString</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004521">Stable:</a></b></dt><dd>ICU 3.0</dd></dl>
</div>
</div>
<a class="anchor" id="aa128ea0ed3869415c1c96a9a2c997c2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* ucol_openRules </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>rulesLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td>
<td class="paramname"><em>normalizationMode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> </td>
<td class="paramname"><em>strength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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>Produce a UCollator instance according to the rules supplied. </p>
<p>The rules are used to change the default ordering, defined in the UCA in a process called tailoring. The resulting UCollator pointer can be used in the same way as the one obtained by <a class="el" href="ucol_8h.html#aa194d8b0092106c0fea4070060790694">ucol_strcoll</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rules</td><td>A string describing the collation rules. For the syntax of the rules please see users guide. </td></tr>
<tr><td class="paramname">rulesLength</td><td>The length of rules, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">normalizationMode</td><td>The normalization mode: One of UCOL_OFF (expect the text to not need normalization), UCOL_ON (normalize), or UCOL_DEFAULT (set the mode according to the rules) </td></tr>
<tr><td class="paramname">strength</td><td>The default collation strength; one of UCOL_PRIMARY, UCOL_SECONDARY, UCOL_TERTIARY, UCOL_IDENTICAL,UCOL_DEFAULT_STRENGTH - can be also set in the rules. </td></tr>
<tr><td class="paramname">parseError</td><td>A pointer to <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors. ">UParseError</a> to recieve information about errors occurred during parsing. This argument can currently be set to NULL, but at users own risk. Please provide a real structure. </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 pointer to a UCollator. It is not guaranteed that NULL be returned in case of error - please use status argument to check for errors. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a4721e4c0a519bb0139a874e191223590" title="Open a UCollator for comparing strings. ">ucol_open</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a917cd8e16df3b35bbe97dd96d881f227" title="Thread safe cloning operation. ">ucol_safeClone</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a68fce4fae47371bfece8a288ef05f11f" title="Close a UCollator. ">ucol_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004520">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af94c268dea700c8772e7955dc2a75759"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_prepareShortStringOpen </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>definition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td>
<td class="paramname"><em>forceDefaults</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>parseError</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>Touches all resources needed for instantiating a collator from a short string definition, thus filling up the cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">definition</td><td>A short string containing a locale and a set of attributes. Attributes not explicitly mentioned are left at the default state for a locale. </td></tr>
<tr><td class="paramname">parseError</td><td>if not NULL, structure that will get filled with error's pre and post context in case of error. </td></tr>
<tr><td class="paramname">forceDefaults</td><td>if FALSE, the settings that are the same as the collator default settings will not be applied (for example, setting French secondary on a French collator would not be executed). If TRUE, all the settings will be applied regardless of the collator default value. If the definition strings are to be cached, should be set to FALSE. </td></tr>
<tr><td class="paramname">status</td><td>Error code. Apart from regular error conditions connected to instantiating collators (like out of memory or similar), this API will return an error if an invalid attribute or attribute/value combination is specified. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a39ccd61fb814dc0d2e759bc0cfe4c80d" title="Open a collator defined by a short form string. ">ucol_openFromShortString</a> </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000437">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="ad10de03e206f2b9dceb59b59e75bc7d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_restoreVariableTop </td>
<td>(</td>
<td class="paramtype"><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 uint32_t </td>
<td class="paramname"><em>varTop</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>Sets the variable top to the specified primary weight. </p>
<p>Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. See <a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">varTop</td><td>primary weight, as returned by ucol_setVariableTop or ucol_getVariableTop </td></tr>
<tr><td class="paramname">status</td><td>error code </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a802cc1a4f7f3e9de7089802294377867" title="Gets the variable top value of a Collator. ">ucol_getVariableTop</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a0e9c28a8b8b88890722daca111207688" title="Sets the variable top to the primary weight of the specified string. ">ucol_setVariableTop</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000262">Deprecated:</a></b></dt><dd>ICU 53 Call <a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="a917cd8e16df3b35bbe97dd96d881f227"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a>* ucol_safeClone </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">void * </td>
<td class="paramname"><em>stackBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pBufferSize</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>Thread safe cloning operation. </p>
<p>The result is a clone of a given collator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator to be cloned </td></tr>
<tr><td class="paramname">stackBuffer</td><td><em>Deprecated functionality as of ICU 52, use NULL.</em><br/>
user allocated space for the new clone. If NULL new memory will be allocated. If buffer is not large enough, new memory will be allocated. Clients can use the U_COL_SAFECLONE_BUFFERSIZE. </td></tr>
<tr><td class="paramname">pBufferSize</td><td><em>Deprecated functionality as of ICU 52, use NULL or 1.</em><br/>
pointer to size of allocated space. If *pBufferSize == 0, a sufficient size for use in cloning will be returned ('pre-flighting') If *pBufferSize is not enough for a stack-based safe clone, new memory will be allocated. </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors An informational status value, U_SAFECLONE_ALLOCATED_ERROR, is used if any allocations were necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the new clone </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a4721e4c0a519bb0139a874e191223590" title="Open a UCollator for comparing strings. ">ucol_open</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#aa128ea0ed3869415c1c96a9a2c997c2d" title="Produce a UCollator instance according to the rules supplied. ">ucol_openRules</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a68fce4fae47371bfece8a288ef05f11f" title="Close a UCollator. ">ucol_close</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004556">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a3a2302e315d5b474f94354cffedeecd7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setAttribute </td>
<td>(</td>
<td class="paramtype"><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"><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c">UColAttribute</a> </td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UColAttributeValue</a> </td>
<td class="paramname"><em>value</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>Universal attribute setter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>collator which attributes are to be changed </td></tr>
<tr><td class="paramname">attr</td><td>attribute type </td></tr>
<tr><td class="paramname">value</td><td>attribute value </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a583fbe7fc4a850e2fcc692e766d2826c" title="Attributes that collation service understands. ">UColAttribute</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a" title="Enum containing attribute values for controling collation behavior. ">UColAttributeValue</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#af96cc7dc7da7981d2d12356b104e058a" title="Universal attribute getter. ">ucol_getAttribute</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004553">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a59507ee73d0aab54bb22f5d05d598138"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setMaxVariable </td>
<td>(</td>
<td class="paramtype"><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"><a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887">UColReorderCode</a> </td>
<td class="paramname"><em>group</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>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the variable top to the top of the specified reordering group. </p>
<p>The variable top determines the highest-sorting character which is affected by UCOL_ALTERNATE_HANDLING. If that attribute is set to UCOL_NON_IGNORABLE, then the variable top has no effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>the collator </td></tr>
<tr><td class="paramname">group</td><td>one of UCOL_REORDER_CODE_SPACE, UCOL_REORDER_CODE_PUNCTUATION, UCOL_REORDER_CODE_SYMBOL, UCOL_REORDER_CODE_CURRENCY; or UCOL_REORDER_CODE_DEFAULT to restore the default max variable group </td></tr>
<tr><td class="paramname">pErrorCode</td><td>Standard ICU error code. Its input value must pass the <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS()</a> test, or else the function returns immediately. Check for <a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure? ">U_FAILURE()</a> on output or use with function chaining. (See User Guide for details.) </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a15526321f50d1b424e659e3726a5ece4" title="Returns the maximum reordering group whose characters are affected by UCOL_ALTERNATE_HANDLING. ">ucol_getMaxVariable</a> </dd></dl>
<dl class="draft"><dt><b><a class="el" href="draft.html#_draft000153">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 53 </dd></dl>
</div>
</div>
<a class="anchor" id="a7473236c4a96983fc1c53c9ab566c2e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setReorderCodes </td>
<td>(</td>
<td class="paramtype"><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 int32_t * </td>
<td class="paramname"><em>reorderCodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>reorderCodesLength</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>pErrorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the reordering codes for this collator. </p>
<p>Collation reordering allows scripts and some other defined blocks of characters to be moved relative to each other as a block. This reordering is done on top of the DUCET/CLDR standard collation order. Reordering can specify groups to be placed at the start and/or the end of the collation order. These groups are specified using UScript codes and UColReorderCode entries. </p>
<p>By default, reordering codes specified for the start of the order are placed in the order given after a group of "special" non-script blocks. These special groups of characters are space, punctuation, symbol, currency, and digit. These special groups are represented with UColReorderCode entries. Script groups can be intermingled with these special non-script blocks if those special blocks are explicitly specified in the reordering. </p>
<p>The special code OTHERS stands for any script that is not explicitly mentioned in the list of reordering codes given. Anything that is after OTHERS will go at the very end of the reordering in the order given. </p>
<p>The special reorder code DEFAULT will reset the reordering for this collator to the default for this collator. The default reordering may be the DUCET/CLDR order or may be a reordering that was specified when this collator was created from resource data or from rules. The DEFAULT code <b>must</b> be the sole code supplied when it used. If not that will result in a U_ILLEGAL_ARGUMENT_ERROR being set. </p>
<p>The special reorder code NONE will remove any reordering for this collator. The result of setting no reordering will be to have the DUCET/CLDR ordering used. The NONE code <b>must</b> be the sole code supplied when it used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to set. </td></tr>
<tr><td class="paramname">reorderCodes</td><td>An array of script codes in the new order. This can be NULL if the length is also set to 0. An empty array will clear any reordering codes on the collator. </td></tr>
<tr><td class="paramname">reorderCodesLength</td><td>The length of reorderCodes. </td></tr>
<tr><td class="paramname">pErrorCode</td><td>Must be a valid pointer to an error code value, which must not indicate a failure before the function call. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a6e3ad662b7141615599dbe11c3c0e328" title="Retrieves the reordering codes for this collator. ">ucol_getReorderCodes</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a3d52959dc92e90d2bccc800fab679e65" title="Retrieves the reorder codes that are grouped with the given reorder code. ">ucol_getEquivalentReorderCodes</a> </dd>
<dd>
<a class="el" href="uscript_8h.html#afee717f56927f828c0fe8aaa3f637303" title="Constants for ISO 15924 script codes. ">UScriptCode</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ae491f1262ff311f19e74830eb685f887" title="Enum containing the codes for reordering segments of the collation table that are not script codes...">UColReorderCode</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004533">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="adcbb3eee538142a06a89e066400dd9b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucol_setStrength </td>
<td>(</td>
<td class="paramtype"><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"><a class="el" href="ucol_8h.html#acc801048729e684bcabed328be85f77a">UCollationStrength</a> </td>
<td class="paramname"><em>strength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the collation strength used in a UCollator. </p>
<p>The strength influences how strings are compared. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator to set. </td></tr>
<tr><td class="paramname">strength</td><td>The desired collation strength; one of UCOL_PRIMARY, UCOL_SECONDARY, UCOL_TERTIARY, UCOL_QUATERNARY, UCOL_IDENTICAL, UCOL_DEFAULT </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#abc4eaea4396300af64c5891fc6c4c0a6" title="Get the collation strength used in a UCollator. ">ucol_getStrength</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004531">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0e9c28a8b8b88890722daca111207688"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ucol_setVariableTop </td>
<td>(</td>
<td class="paramtype"><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>varTop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>len</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>Sets the variable top to the primary weight of the specified string. </p>
<p>Beginning with ICU 53, the variable top is pinned to the top of one of the supported reordering groups, and it must not be beyond the last of those groups. See <a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>the collator </td></tr>
<tr><td class="paramname">varTop</td><td>one or more (if contraction) UChars to which the variable top should be set </td></tr>
<tr><td class="paramname">len</td><td>length of variable top string. If -1 it is considered to be zero terminated. </td></tr>
<tr><td class="paramname">status</td><td>error code. If error code is set, the return value is undefined. Errors set by this function are:<br/>
U_CE_NOT_FOUND_ERROR if more than one character was passed and there is no such contraction<br/>
U_ILLEGAL_ARGUMENT_ERROR if the variable top is beyond the last reordering group supported by <a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>variable top primary weight </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#a802cc1a4f7f3e9de7089802294377867" title="Gets the variable top value of a Collator. ">ucol_getVariableTop</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad10de03e206f2b9dceb59b59e75bc7d8" title="Sets the variable top to the specified primary weight. ">ucol_restoreVariableTop</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000261">Deprecated:</a></b></dt><dd>ICU 53 Call <a class="el" href="ucol_8h.html#a59507ee73d0aab54bb22f5d05d598138" title="Sets the variable top to the top of the specified reordering group. ">ucol_setMaxVariable()</a> instead. </dd></dl>
</div>
</div>
<a class="anchor" id="aa194d8b0092106c0fea4070060790694"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> ucol_strcoll </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>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</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>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compare two strings. </p>
<p>The strings will be compared using the options already specified. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">source</td><td>The source string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>The target string. </td></tr>
<tr><td class="paramname">targetLength</td><td>The length of target, or -1 if null-terminated. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The result of comparing the strings; one of UCOL_EQUAL, UCOL_GREATER, UCOL_LESS </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa9eb676fde40581f43cc7eb24b597e0e" title="Determine if one string is greater than another. ">ucol_greater</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad04f5b8001a319c71f1dc2da06519091" title="Determine if one string is greater than or equal to another. ">ucol_greaterOrEqual</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad592bf65b8b5859ea06ab565f0e6e869" title="Compare two strings for equality. ">ucol_equal</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004524">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad62f08d678b62cf17825f3237ff0315c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> ucol_strcollIter </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"><a class="el" href="structUCharIterator.html">UCharIterator</a> * </td>
<td class="paramname"><em>sIter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUCharIterator.html">UCharIterator</a> * </td>
<td class="paramname"><em>tIter</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>Compare two UTF-8 encoded trings. </p>
<p>The strings will be compared using the options already specified. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">sIter</td><td>The source string iterator. </td></tr>
<tr><td class="paramname">tIter</td><td>The target string iterator. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The result of comparing the strings; one of UCOL_EQUAL, UCOL_GREATER, UCOL_LESS </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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="ucol_8h.html#aa194d8b0092106c0fea4070060790694" title="Compare two strings. ">ucol_strcoll</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004529">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a3abc6779e6452106415918199308fab4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ucol_8h.html#a8b4e71db8109af87f84ac1576e2b245d">UCollationResult</a> ucol_strcollUTF8 </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 char * </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>sourceLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>targetLength</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>Compare two strings in UTF-8. </p>
<p>The strings will be compared using the options already specified. Note: When input string contains malformed a UTF-8 byte sequence, this function treats these bytes as REPLACEMENT CHARACTER (U+FFFD). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">coll</td><td>The UCollator containing the comparison rules. </td></tr>
<tr><td class="paramname">source</td><td>The source UTF-8 string. </td></tr>
<tr><td class="paramname">sourceLength</td><td>The length of source, or -1 if null-terminated. </td></tr>
<tr><td class="paramname">target</td><td>The target UTF-8 string. </td></tr>
<tr><td class="paramname">targetLength</td><td>The length of target, 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>The result of comparing the strings; one of UCOL_EQUAL, UCOL_GREATER, UCOL_LESS </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="ucol_8h.html#aa9eb676fde40581f43cc7eb24b597e0e" title="Determine if one string is greater than another. ">ucol_greater</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad04f5b8001a319c71f1dc2da06519091" title="Determine if one string is greater than or equal to another. ">ucol_greaterOrEqual</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#ad592bf65b8b5859ea06ab565f0e6e869" title="Compare two strings for equality. ">ucol_equal</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004525">Stable:</a></b></dt><dd>ICU 50 </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
>
1316
