<!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"/> <title>ICU 52.1: ucoleitr.h Source File</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="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 52.1  <span id="projectnumber">52.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.2 --> <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> </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> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">ucoleitr.h</div> </div> </div><!--header--> <div class="contents"> <a href="ucoleitr_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">*******************************************************************************</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Copyright (C) 2001-2011, International Business Machines</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">*******************************************************************************</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* File ucoleitr.cpp</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">*</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* Modification History:</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* Date Name Description</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* 02/15/2001 synwee Modified all methods to process its own function </span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* instead of calling the equivalent c++ api (coleitr.h)</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">*******************************************************************************/</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef UCOLEITR_H</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span><span class="preprocessor">#define UCOLEITR_H</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#if !UCONFIG_NO_COLLATION</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="ucoleitr_8h.html#a07efa63d179b459db763ffcfe16fdef8"> 28</a></span> <span class="preprocessor">#define UCOL_NULLORDER ((int32_t)0xFFFFFFFF)</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifndef U_HIDE_INTERNAL_API</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="ucoleitr_8h.html#aeccb9dc10190906d7c09285ab1d02bcb"> 37</a></span> <span class="preprocessor">#define UCOL_PROCESSED_NULLORDER ((int64_t)U_INT64_MAX)</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_INTERNAL_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="ucol_8h.html" title="C API: Collator.">unicode/ucol.h</a>"</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="ucoleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5"> 47</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> <a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a>;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a>* U_EXPORT2 </div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <a class="code" href="ucoleitr_8h.html#a1b02b847bb095a5525ed4b7f55a69eb5" title="Open the collation elements for a string.">ucol_openElements</a>(<span class="keyword">const</span> <a class="code" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081" title="structure representing a collator object instance">UCollator</a> *coll,</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...">UChar</a> *text,</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  int32_t textLength,</div> <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div> <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2 </div> <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <a class="code" href="ucoleitr_8h.html#a705331b3ca250e3f5f74accfee861fa4" title="get a hash code for a key...">ucol_keyHashCode</a>(<span class="keyword">const</span> uint8_t* key, int32_t length);</div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <a class="code" href="ucoleitr_8h.html#a38185a0b06fe59058c4ed4a87c6d7ff9" title="Close a UCollationElements.">ucol_closeElements</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems);</div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div> <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <a class="code" href="ucoleitr_8h.html#af9b4a63d9bba05b4635c0d2626b45a37" title="Reset the collation elements to their initial state.">ucol_reset</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems);</div> <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div> <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#ifndef U_HIDE_INTERNAL_API</span></div> <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <a class="code" href="umachine_8h.html#a161dba69f4e479c3626793efc42f94ba" title="This is used to declare a function as an internal ICU C API.">U_INTERNAL</a> <span class="keywordtype">void</span> U_EXPORT2</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <a class="code" href="ucoleitr_8h.html#a3ff5c01970b57cd1f26c886613fcec6c" title="Set the collation elements to use implicit ordering for Han even if they've been tailored.">ucol_forceHanImplicit</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_INTERNAL_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2 </div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <a class="code" href="ucoleitr_8h.html#afac0d24bf026d9ea4933cef911022370" title="Get the ordering priority of the next collation element in the text.">ucol_next</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2 </div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <a class="code" href="ucoleitr_8h.html#ad6718e09e014e8dcde9f0bae75fe96f5" title="Get the ordering priority of the previous collation element in the text.">ucol_previous</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor">#ifndef U_HIDE_INTERNAL_API</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <a class="code" href="umachine_8h.html#a161dba69f4e479c3626793efc42f94ba" title="This is used to declare a function as an internal ICU C API.">U_INTERNAL</a> int64_t U_EXPORT2</div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <a class="code" href="ucoleitr_8h.html#ad4e6efc24ee31f2429a97611342b82c8" title="Get the processed ordering priority of the next collation element in the text.">ucol_nextProcessed</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, int32_t *ixLow, int32_t *ixHigh, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <a class="code" href="umachine_8h.html#a161dba69f4e479c3626793efc42f94ba" title="This is used to declare a function as an internal ICU C API.">U_INTERNAL</a> int64_t U_EXPORT2</div> <div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <a class="code" href="ucoleitr_8h.html#a7dae07b3d61162039e0fdcf1bf549261" title="Get the processed ordering priority of the previous collation element in the text.">ucol_previousProcessed</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, int32_t *ixLow, int32_t *ixHigh, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="preprocessor">#endif </span><span class="comment">/* U_HIDE_INTERNAL_API */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2 </div> <div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <a class="code" href="ucoleitr_8h.html#ab87f69840736227870f8b1d47b6ddffd" title="Get the maximum length of any expansion sequences that end with the specified comparison order...">ucol_getMaxExpansion</a>(<span class="keyword">const</span> <a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, int32_t order);</div> <div class="line"><a name="l00259"></a><span class="lineno"> 259</span> </div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <a class="code" href="ucoleitr_8h.html#adb1bfe771ae3ff78dd52be29390e81fe" title="Set the text containing the collation elements.">ucol_setText</a>( <a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems, </div> <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...">UChar</a> *text,</div> <div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  int32_t textLength,</div> <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2 </div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <a class="code" href="ucoleitr_8h.html#a03951847045960de23b022dc4722cda0" title="Get the offset of the current source character.">ucol_getOffset</a>(<span class="keyword">const</span> <a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems);</div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div> <div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2 </div> <div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <a class="code" href="ucoleitr_8h.html#aa301bde0ec5eca09f5f069dd3ce934c4" title="Set the offset of the current source character.">ucol_setOffset</a>(<a class="code" href="coleitr_8h.html#a5f2296c3961afacfbba2a5ee850ca1d5" title="File coleitr.h.">UCollationElements</a> *elems,</div> <div class="line"><a name="l00304"></a><span class="lineno"> 304</span>  int32_t offset,</div> <div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all C++ compilers...">UErrorCode</a> *status);</div> <div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div> <div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2</div> <div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <a class="code" href="ucoleitr_8h.html#a346bfd807642b81527581c6194f003dd" title="Get the primary order of a collation order.">ucol_primaryOrder</a> (int32_t order); </div> <div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div> <div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2</div> <div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <a class="code" href="ucoleitr_8h.html#a5afa9446c3f57ab675f74d91d4d04b2e" title="Get the secondary order of a collation order.">ucol_secondaryOrder</a> (int32_t order); </div> <div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98" title="This is used to declare a function as a stable public ICU C API.">U_STABLE</a> int32_t U_EXPORT2</div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <a class="code" href="ucoleitr_8h.html#a469d805add17198dc5c118700c04b35a" title="Get the tertiary order of a collation order.">ucol_tertiaryOrder</a> (int32_t order); </div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span> </div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="preprocessor">#endif </span><span class="comment">/* #if !UCONFIG_NO_COLLATION */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Oct 4 2013 14:10:21 for ICU 52.1 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1.2 </small></address> </body> </html>