<!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.3.1"/>
<title>ICU 49.1.1: UCharsTrie::Iterator Class 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="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 49.1.1
 <span id="projectnumber">49.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="classUCharsTrie.html">UCharsTrie</a></li><li class="navelem"><a class="el" href="classUCharsTrie_1_1Iterator.html">Iterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">UCharsTrie::Iterator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classUCharsTrie_1_1Iterator.html" title="Iterator for all of the (string, value) pairs in a UCharsTrie.">Iterator</a> for all of the (string, value) pairs in a <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>.
<a href="classUCharsTrie_1_1Iterator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ucharstrie_8h_source.html">ucharstrie.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for UCharsTrie::Iterator:</div>
<div class="dyncontent">
<div class="center">
<img src="classUCharsTrie_1_1Iterator.png" usemap="#UCharsTrie::Iterator_map" alt=""/>
<map id="UCharsTrie::Iterator_map" name="UCharsTrie::Iterator_map">
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,122,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad9ca0d08fca2d18ce1328b5d709d2d27"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#ad9ca0d08fca2d18ce1328b5d709d2d27">Iterator</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *trieUChars, int32_t maxStringLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:ad9ca0d08fca2d18ce1328b5d709d2d27"><td class="mdescLeft"> </td><td class="mdescRight">Iterates from the root of a UChar-serialized <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>. <a href="#ad9ca0d08fca2d18ce1328b5d709d2d27">More...</a><br/></td></tr>
<tr class="separator:ad9ca0d08fca2d18ce1328b5d709d2d27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2398231808b66ea2540a7f3de1337361"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#a2398231808b66ea2540a7f3de1337361">Iterator</a> (const <a class="el" href="classUCharsTrie.html">UCharsTrie</a> &trie, int32_t maxStringLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a2398231808b66ea2540a7f3de1337361"><td class="mdescLeft"> </td><td class="mdescRight">Iterates from the current state of the specified <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>. <a href="#a2398231808b66ea2540a7f3de1337361">More...</a><br/></td></tr>
<tr class="separator:a2398231808b66ea2540a7f3de1337361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace6db41490c49b2cf468df148cacbbc7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#ace6db41490c49b2cf468df148cacbbc7">~Iterator</a> ()</td></tr>
<tr class="memdesc:ace6db41490c49b2cf468df148cacbbc7"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace6db41490c49b2cf468df148cacbbc7">More...</a><br/></td></tr>
<tr class="separator:ace6db41490c49b2cf468df148cacbbc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd1f0144499010c5b998d8032d859f0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUCharsTrie_1_1Iterator.html">Iterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#afd1f0144499010c5b998d8032d859f0e">reset</a> ()</td></tr>
<tr class="memdesc:afd1f0144499010c5b998d8032d859f0e"><td class="mdescLeft"> </td><td class="mdescRight">Resets this iterator to its initial state. <a href="#afd1f0144499010c5b998d8032d859f0e">More...</a><br/></td></tr>
<tr class="separator:afd1f0144499010c5b998d8032d859f0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acfd0aeb046a14c88a6c852ddbec71af3"><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="classUCharsTrie_1_1Iterator.html#acfd0aeb046a14c88a6c852ddbec71af3">hasNext</a> () const </td></tr>
<tr class="separator:acfd0aeb046a14c88a6c852ddbec71af3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a880d8a4dc7b821844e0fea8625336714"><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="classUCharsTrie_1_1Iterator.html#a880d8a4dc7b821844e0fea8625336714">next</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr>
<tr class="memdesc:a880d8a4dc7b821844e0fea8625336714"><td class="mdescLeft"> </td><td class="mdescRight">Finds the next (string, value) pair if there is one. <a href="#a880d8a4dc7b821844e0fea8625336714">More...</a><br/></td></tr>
<tr class="separator:a880d8a4dc7b821844e0fea8625336714"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ea63a65e975198bd7c7d5aac1849cb7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#a5ea63a65e975198bd7c7d5aac1849cb7">getString</a> () const </td></tr>
<tr class="separator:a5ea63a65e975198bd7c7d5aac1849cb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47baaec6d69446c9558946a79b2adf48"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classUCharsTrie_1_1Iterator.html#a47baaec6d69446c9558946a79b2adf48">getValue</a> () const </td></tr>
<tr class="separator:a47baaec6d69446c9558946a79b2adf48"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classUCharsTrie_1_1Iterator.html" title="Iterator for all of the (string, value) pairs in a UCharsTrie.">Iterator</a> for all of the (string, value) pairs in a <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001233">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ucharstrie_8h_source.html#l00256">256</a> of file <a class="el" href="ucharstrie_8h_source.html">ucharstrie.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad9ca0d08fca2d18ce1328b5d709d2d27"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UCharsTrie::Iterator::Iterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>trieUChars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>maxStringLength</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>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates from the root of a UChar-serialized <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trieUChars</td><td>The trie UChars. </td></tr>
<tr><td class="paramname">maxStringLength</td><td>If 0, the iterator returns full strings. Otherwise, the iterator returns strings with this maximum length. </td></tr>
<tr><td class="paramname">errorCode</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="stable"><dt><b><a class="el" href="stable.html#_stable001235">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a2398231808b66ea2540a7f3de1337361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UCharsTrie::Iterator::Iterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUCharsTrie.html">UCharsTrie</a> & </td>
<td class="paramname"><em>trie</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>maxStringLength</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>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates from the current state of the specified <a class="el" href="classUCharsTrie.html" title="Light-weight, non-const reader class for a UCharsTrie.">UCharsTrie</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">trie</td><td>The trie whose state will be copied for iteration. </td></tr>
<tr><td class="paramname">maxStringLength</td><td>If 0, the iterator returns full strings. Otherwise, the iterator returns strings with this maximum length. </td></tr>
<tr><td class="paramname">errorCode</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="stable"><dt><b><a class="el" href="stable.html#_stable001236">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="ace6db41490c49b2cf468df148cacbbc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UCharsTrie::Iterator::~Iterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001237">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5ea63a65e975198bd7c7d5aac1849cb7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classUnicodeString.html">UnicodeString</a>& UCharsTrie::Iterator::getString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The string for the last successful <a class="el" href="classUCharsTrie_1_1Iterator.html#a880d8a4dc7b821844e0fea8625336714" title="Finds the next (string, value) pair if there is one.">next()</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001241">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ucharstrie_8h_source.html#l00323">323</a> of file <a class="el" href="ucharstrie_8h_source.html">ucharstrie.h</a>.</p>
</div>
</div>
<a class="anchor" id="a47baaec6d69446c9558946a79b2adf48"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int32_t UCharsTrie::Iterator::getValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The value for the last successful <a class="el" href="classUCharsTrie_1_1Iterator.html#a880d8a4dc7b821844e0fea8625336714" title="Finds the next (string, value) pair if there is one.">next()</a>. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001242">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="ucharstrie_8h_source.html#l00328">328</a> of file <a class="el" href="ucharstrie_8h_source.html">ucharstrie.h</a>.</p>
</div>
</div>
<a class="anchor" id="acfd0aeb046a14c88a6c852ddbec71af3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> UCharsTrie::Iterator::hasNext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>TRUE if there are more elements. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001239">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a880d8a4dc7b821844e0fea8625336714"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> UCharsTrie::Iterator::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>errorCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the next (string, value) pair if there is one. </p>
<p>If the string is truncated to the maximum length and does not have a real value, then the value is set to -1. In this case, this "not a real value" is indistinguishable from a real value of -1. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">errorCode</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 return"><dt>Returns</dt><dd>TRUE if there is another element. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001240">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="afd1f0144499010c5b998d8032d859f0e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUCharsTrie_1_1Iterator.html">Iterator</a>& UCharsTrie::Iterator::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets this iterator to its initial state. </p>
<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001238">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ucharstrie_8h_source.html">ucharstrie.h</a></li>
</ul>
</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.3.1
</small></address>
</body>
</html>
