📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-22 17:24:26
📂
/ (Root)
/
opt
/
alt
/
alt-nodejs14
/
root
/
usr
/
share
/
doc
/
alt-nodejs14-libicu-doc
📍 /opt/alt/alt-nodejs14/root/usr/share/doc/alt-nodejs14-libicu-doc
🔄 Refresh
✏️
Editing: uenum_8h_source.html
Read Only
<!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.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ICU 67.1: uenum.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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 67.1  <span id="projectnumber">67.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">uenum.h</div> </div> </div><!--header--> <div class="contents"> <a href="uenum_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">// © 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">*******************************************************************************</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">* Copyright (C) 2002-2013, International Business Machines</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* Corporation and others. All Rights Reserved.</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">*******************************************************************************</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* file name: uenum.h</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* encoding: UTF-8</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* tab size: 8 (not used)</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* indentation:2</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> <span class="comment">* created on: 2002jul08</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* created by: Vladimir Weinstein</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef __UENUM_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define __UENUM_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="localpointer_8h.html">unicode/localpointer.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> U_NAMESPACE_BEGIN</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">class </span>StringEnumeration;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> U_NAMESPACE_END</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">struct </span><a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d"> 43</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a> <a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <a class="code" href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df">uenum_close</a>(<a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* en);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> U_NAMESPACE_BEGIN</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <a class="code" href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a>(<a class="code" href="classLocalUEnumerationPointer.html">LocalUEnumerationPointer</a>, <a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>, <a class="code" href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df">uenum_close</a>);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> U_NAMESPACE_END</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> int32_t U_EXPORT2</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="uenum_8h.html#a8be6db20419d79ecdd71e717a9521773">uenum_count</a>(<a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* en, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* U_EXPORT2</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <a class="code" href="uenum_8h.html#af7afc38ba0ea6071b03b052209e2e07d">uenum_unext</a>(<a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* en,</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  int32_t* resultLength,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* U_EXPORT2</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <a class="code" href="uenum_8h.html#a99298eabaa3874cdfd9793b207848f68">uenum_next</a>(<a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* en,</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  int32_t* resultLength,</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <a class="code" href="uenum_8h.html#a76b3866509601b228ee72fa4089107bb">uenum_reset</a>(<a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* en, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* U_EXPORT2</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <a class="code" href="uenum_8h.html#a88072e393a0901f374bb09859dc1e093">uenum_openFromStringEnumeration</a>(<a class="code" href="classicu_1_1StringEnumeration.html">icu::StringEnumeration</a>* adopted, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* ec);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* U_EXPORT2</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <a class="code" href="uenum_8h.html#aaa11700a992ef714551e6a2ae001b091">uenum_openUCharStringsEnumeration</a>(<span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* <span class="keyword">const</span> strings[], int32_t count,</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* ec);</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <a class="code" href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a>* U_EXPORT2</div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <a class="code" href="uenum_8h.html#a89298631a5febaa31b04cf7982e2d1f7">uenum_openCharStringsEnumeration</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keyword">const</span> strings[], int32_t count,</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* ec);</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="uenum_8h_html_af8bf1abcf3a486f07ee3384c7fce89df"><div class="ttname"><a href="uenum_8h.html#af8bf1abcf3a486f07ee3384c7fce89df">uenum_close</a></div><div class="ttdeci">void uenum_close(UEnumeration *en)</div><div class="ttdoc">Disposes of resources in use by the iterator. </div></div> <div class="ttc" id="uenum_8h_html_aaa11700a992ef714551e6a2ae001b091"><div class="ttname"><a href="uenum_8h.html#aaa11700a992ef714551e6a2ae001b091">uenum_openUCharStringsEnumeration</a></div><div class="ttdeci">UEnumeration * uenum_openUCharStringsEnumeration(const UChar *const strings[], int32_t count, UErrorCode *ec)</div><div class="ttdoc">Given an array of const UChar* strings, return a UEnumeration. </div></div> <div class="ttc" id="uenum_8h_html_a32b7253b2148022535be36a9fcdb5a8d"><div class="ttname"><a href="uenum_8h.html#a32b7253b2148022535be36a9fcdb5a8d">UEnumeration</a></div><div class="ttdeci">struct UEnumeration UEnumeration</div><div class="ttdoc">structure representing an enumeration object instance </div><div class="ttdef"><b>Definition:</b> <a href="uenum_8h_source.html#l00043">uenum.h:43</a></div></div> <div class="ttc" id="classicu_1_1StringEnumeration_html"><div class="ttname"><a href="classicu_1_1StringEnumeration.html">icu::StringEnumeration</a></div><div class="ttdoc">Base class for &#39;pure&#39; C++ implementations of uenum api. </div><div class="ttdef"><b>Definition:</b> <a href="strenum_8h_source.html#l00061">strenum.h:61</a></div></div> <div class="ttc" id="uenum_8h_html_a99298eabaa3874cdfd9793b207848f68"><div class="ttname"><a href="uenum_8h.html#a99298eabaa3874cdfd9793b207848f68">uenum_next</a></div><div class="ttdeci">const char * uenum_next(UEnumeration *en, int32_t *resultLength, UErrorCode *status)</div><div class="ttdoc">Returns the next element in the iterator&#39;s list. </div></div> <div class="ttc" id="uenum_8h_html_af7afc38ba0ea6071b03b052209e2e07d"><div class="ttname"><a href="uenum_8h.html#af7afc38ba0ea6071b03b052209e2e07d">uenum_unext</a></div><div class="ttdeci">const UChar * uenum_unext(UEnumeration *en, int32_t *resultLength, UErrorCode *status)</div><div class="ttdoc">Returns the next element in the iterator&#39;s list. </div></div> <div class="ttc" id="localpointer_8h_html_a3030f841466c4bbbd465ac9c4b999549"><div class="ttname"><a href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a></div><div class="ttdeci">#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)</div><div class="ttdoc">"Smart pointer" definition macro, deletes objects via the closeFunction. </div><div class="ttdef"><b>Definition:</b> <a href="localpointer_8h_source.html#l00550">localpointer.h:550</a></div></div> <div class="ttc" id="localpointer_8h_html"><div class="ttname"><a href="localpointer_8h.html">localpointer.h</a></div><div class="ttdoc">C++ API: "Smart pointers" for use with and in ICU4C C++ code. </div></div> <div class="ttc" id="uenum_8h_html_a8be6db20419d79ecdd71e717a9521773"><div class="ttname"><a href="uenum_8h.html#a8be6db20419d79ecdd71e717a9521773">uenum_count</a></div><div class="ttdeci">int32_t uenum_count(UEnumeration *en, UErrorCode *status)</div><div class="ttdoc">Returns the number of elements that the iterator traverses. </div></div> <div class="ttc" id="uenum_8h_html_a89298631a5febaa31b04cf7982e2d1f7"><div class="ttname"><a href="uenum_8h.html#a89298631a5febaa31b04cf7982e2d1f7">uenum_openCharStringsEnumeration</a></div><div class="ttdeci">UEnumeration * uenum_openCharStringsEnumeration(const char *const strings[], int32_t count, UErrorCode *ec)</div><div class="ttdoc">Given an array of const char* strings (invariant chars only), return a UEnumeration. </div></div> <div class="ttc" id="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">char16_t UChar</div><div class="ttdoc">The base type for UTF-16 code units and pointers. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00376">umachine.h:376</a></div></div> <div class="ttc" id="utypes_8h_html_a3343c1c8a8377277046774691c98d78c"><div class="ttname"><a href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a></div><div class="ttdeci">UErrorCode</div><div class="ttdoc">Standard ICU4C error code type, a substitute for exceptions. </div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00415">utypes.h:415</a></div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> <div class="ttc" id="classLocalUEnumerationPointer_html"><div class="ttname"><a href="classLocalUEnumerationPointer.html">LocalUEnumerationPointer</a></div><div class="ttdoc">"Smart pointer" class, closes a UEnumeration via uenum_close(). </div></div> <div class="ttc" id="uenum_8h_html_a76b3866509601b228ee72fa4089107bb"><div class="ttname"><a href="uenum_8h.html#a76b3866509601b228ee72fa4089107bb">uenum_reset</a></div><div class="ttdeci">void uenum_reset(UEnumeration *en, UErrorCode *status)</div><div class="ttdoc">Resets the iterator to the current list of service IDs. </div></div> <div class="ttc" id="uenum_8h_html_a88072e393a0901f374bb09859dc1e093"><div class="ttname"><a href="uenum_8h.html#a88072e393a0901f374bb09859dc1e093">uenum_openFromStringEnumeration</a></div><div class="ttdeci">UEnumeration * uenum_openFromStringEnumeration(icu::StringEnumeration *adopted, UErrorCode *ec)</div><div class="ttdoc">Given a StringEnumeration, wrap it in a UEnumeration. </div></div> <div class="ttc" id="umachine_8h_html_af3e3799716eaa41e3f49c7bf18c62b98"><div class="ttname"><a href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a></div><div class="ttdeci">#define U_STABLE</div><div class="ttdoc">This is used to declare a function as a stable public ICU C API. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00111">umachine.h:111</a></div></div> </div><!-- fragment --></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.14 </small></address> </body> </html>
💾 Save Changes
❌ Cancel