<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: UCharIterator Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>UCharIterator Struct Reference</h1><!-- doxytag: class="UCharIterator" -->C API for code unit iteration.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="uiter_8h-source.html">uiter.h</a>></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#33f323cfae0faa809f047874d2021fe6">context</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer to string or wrapped object or similar. <a href="#33f323cfae0faa809f047874d2021fe6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#52856eb702c1198d0d49e8a4de0d8629">length</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Length of string or similar. <a href="#52856eb702c1198d0d49e8a4de0d8629"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#cbc6d2bf546d7e98744e2f0d776bec72">start</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Start index or similar. <a href="#cbc6d2bf546d7e98744e2f0d776bec72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#1dcd0ca0875b1be0ba2f399c6920e6fa">index</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Current index or similar. <a href="#1dcd0ca0875b1be0ba2f399c6920e6fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#68042932fad8301133ef8bc82f901305">limit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Limit index or similar. <a href="#68042932fad8301133ef8bc82f901305"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#5d28abc1c284a02d887651c0594d2181">reservedField</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Used by UTF-8 iterators and possibly others. <a href="#5d28abc1c284a02d887651c0594d2181"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#1e20dbf7ee31665308060414ab33896d">UCharIteratorGetIndex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#3d8274db3ff99ebb6bb2d0784c9cd7ca">getIndex</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Returns the current position or the start or limit index of the iteration range. <a href="#3d8274db3ff99ebb6bb2d0784c9cd7ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#685b93cd5dd64a1c28ff243de0970e66">UCharIteratorMove</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#085355b29925cbf9170e364e9aef7bc5">move</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Moves the current position relative to the start or limit of the iteration range, or relative to the current position itself. <a href="#085355b29925cbf9170e364e9aef7bc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#8df87a03c91a3e20012949de43c59381">UCharIteratorHasNext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#c6dc92d309ace93dc07ad9092e807578">hasNext</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Check if <a class="el" href="structUCharIterator.html#c247dee1b3e3e6fec6688f9dcb5bc1c6">current()</a> and <a class="el" href="structUCharIterator.html#ae26243728a62e6a13ed2008972afb50">next()</a> can still return another code unit. <a href="#c6dc92d309ace93dc07ad9092e807578"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#238ebeaecab0965abb28c6732b151ed1">UCharIteratorHasPrevious</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#5a5d536cc7275cdba8b6b2487a4f75a6">hasPrevious</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Check if <a class="el" href="structUCharIterator.html#65cd2a527c6abe69a0f37a368ce51cfb">previous()</a> can still return another code unit. <a href="#5a5d536cc7275cdba8b6b2487a4f75a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#e4162b85c1ce61e161e0d6832fb5ae25">UCharIteratorCurrent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#c247dee1b3e3e6fec6688f9dcb5bc1c6">current</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Return the code unit at the current position, or U_SENTINEL if there is none (index is at the limit). <a href="#c247dee1b3e3e6fec6688f9dcb5bc1c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#8e9ad76bae5c0639e7c2dde67982ed73">UCharIteratorNext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#ae26243728a62e6a13ed2008972afb50">next</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Return the code unit at the current index and increment the index (post-increment, like s[i++]), or return U_SENTINEL if there is none (index is at the limit). <a href="#ae26243728a62e6a13ed2008972afb50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#e84be008356b2c440211befa29f30af0">UCharIteratorPrevious</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#65cd2a527c6abe69a0f37a368ce51cfb">previous</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Decrement the index and return the code unit from there (pre-decrement, like s[--i]), or return U_SENTINEL if there is none (index is at the start). <a href="#65cd2a527c6abe69a0f37a368ce51cfb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#80d5b61426ccc309c318963ecadd9fe0">UCharIteratorReserved</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#94b7ab71aadd2cbafa7394c1102cdf2f">reservedFn</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Reserved for future use. <a href="#94b7ab71aadd2cbafa7394c1102cdf2f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#c89c7dfd00ad111aae63f094cc427b5a">UCharIteratorGetState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#dbdac3a7450c4b9344aad58b1e72d1b4">getState</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Return the state of the iterator, to be restored later with <a class="el" href="structUCharIterator.html#d216d787e1125bc81b49686c7700b52f">setState()</a>. <a href="#dbdac3a7450c4b9344aad58b1e72d1b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="uiter_8h.html#51424ac3e57c7d9502f84a048186c99a">UCharIteratorSetState</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUCharIterator.html#d216d787e1125bc81b49686c7700b52f">setState</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Restore the iterator state from the state word from a call to <a class="el" href="structUCharIterator.html#dbdac3a7450c4b9344aad58b1e72d1b4">getState()</a>. <a href="#d216d787e1125bc81b49686c7700b52f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
C API for code unit iteration.
<p>
This can be used as a C wrapper around <a class="el" href="classCharacterIterator.html">CharacterIterator</a>, <a class="el" href="classReplaceable.html">Replaceable</a>, or implemented using simple strings, etc.<p>
There are two roles for using <a class="el" href="structUCharIterator.html">UCharIterator</a>:<p>
A "provider" sets the necessary function pointers and controls the "protected" fields of the <a class="el" href="structUCharIterator.html">UCharIterator</a> structure. A "provider" passes a <a class="el" href="structUCharIterator.html">UCharIterator</a> into C APIs that need a <a class="el" href="structUCharIterator.html">UCharIterator</a> as an abstract, flexible string interface.<p>
Implementations of such C APIs are "callers" of <a class="el" href="structUCharIterator.html">UCharIterator</a> functions; they only use the "public" function pointers and never access the "protected" fields directly.<p>
The <a class="el" href="structUCharIterator.html#c247dee1b3e3e6fec6688f9dcb5bc1c6">current()</a> and <a class="el" href="structUCharIterator.html#ae26243728a62e6a13ed2008972afb50">next()</a> functions only check the current index against the limit, and <a class="el" href="structUCharIterator.html#65cd2a527c6abe69a0f37a368ce51cfb">previous()</a> only checks the current index against the start, to see if the iterator already reached the end of the iteration range.<p>
The assumption - in all iterators - is that the index is moved via the API, which means it won't go out of bounds, or the index is modified by user code that knows enough about the iterator implementation to set valid index values.<p>
<a class="el" href="structUCharIterator.html">UCharIterator</a> functions return code unit values 0..0xffff, or U_SENTINEL if the iteration bounds are reached.<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001122">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00339">339</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.<hr><h2>Field Documentation</h2>
<a class="anchor" name="33f323cfae0faa809f047874d2021fe6"></a><!-- doxytag: member="UCharIterator::context" ref="33f323cfae0faa809f047874d2021fe6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="structUCharIterator.html#33f323cfae0faa809f047874d2021fe6">UCharIterator::context</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Pointer to string or wrapped object or similar.
<p>
Not used by caller. <dl compact><dt><b><a class="el" href="stable.html#_stable001132">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00345">345</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="52856eb702c1198d0d49e8a4de0d8629"></a><!-- doxytag: member="UCharIterator::length" ref="52856eb702c1198d0d49e8a4de0d8629" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="structUCharIterator.html#52856eb702c1198d0d49e8a4de0d8629">UCharIterator::length</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Length of string or similar.
<p>
Not used by caller. <dl compact><dt><b><a class="el" href="stable.html#_stable001133">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00352">352</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="cbc6d2bf546d7e98744e2f0d776bec72"></a><!-- doxytag: member="UCharIterator::start" ref="cbc6d2bf546d7e98744e2f0d776bec72" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="structUCharIterator.html#cbc6d2bf546d7e98744e2f0d776bec72">UCharIterator::start</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Start index or similar.
<p>
Not used by caller. <dl compact><dt><b><a class="el" href="stable.html#_stable001134">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00359">359</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="1dcd0ca0875b1be0ba2f399c6920e6fa"></a><!-- doxytag: member="UCharIterator::index" ref="1dcd0ca0875b1be0ba2f399c6920e6fa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="structUCharIterator.html#1dcd0ca0875b1be0ba2f399c6920e6fa">UCharIterator::index</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Current index or similar.
<p>
Not used by caller. <dl compact><dt><b><a class="el" href="stable.html#_stable001135">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00366">366</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="68042932fad8301133ef8bc82f901305"></a><!-- doxytag: member="UCharIterator::limit" ref="68042932fad8301133ef8bc82f901305" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="structUCharIterator.html#68042932fad8301133ef8bc82f901305">UCharIterator::limit</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Limit index or similar.
<p>
Not used by caller. <dl compact><dt><b><a class="el" href="stable.html#_stable001136">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00373">373</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="5d28abc1c284a02d887651c0594d2181"></a><!-- doxytag: member="UCharIterator::reservedField" ref="5d28abc1c284a02d887651c0594d2181" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pwin32_8h.html#b1967d8591af1a4e48c37fd2b0f184d0">int32_t</a> <a class="el" href="structUCharIterator.html#5d28abc1c284a02d887651c0594d2181">UCharIterator::reservedField</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(protected) Used by UTF-8 iterators and possibly others.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable001137">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00379">379</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="3d8274db3ff99ebb6bb2d0784c9cd7ca"></a><!-- doxytag: member="UCharIterator::getIndex" ref="3d8274db3ff99ebb6bb2d0784c9cd7ca" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#1e20dbf7ee31665308060414ab33896d">UCharIteratorGetIndex</a>* <a class="el" href="structUCharIterator.html#3d8274db3ff99ebb6bb2d0784c9cd7ca">UCharIterator::getIndex</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Returns the current position or the start or limit index of the iteration range.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#1e20dbf7ee31665308060414ab33896d">UCharIteratorGetIndex</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001138">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00388">388</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="085355b29925cbf9170e364e9aef7bc5"></a><!-- doxytag: member="UCharIterator::move" ref="085355b29925cbf9170e364e9aef7bc5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#685b93cd5dd64a1c28ff243de0970e66">UCharIteratorMove</a>* <a class="el" href="structUCharIterator.html#085355b29925cbf9170e364e9aef7bc5">UCharIterator::move</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Moves the current position relative to the start or limit of the iteration range, or relative to the current position itself.
<p>
The movement is expressed in numbers of code units forward or backward by specifying a positive or negative delta.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#685b93cd5dd64a1c28ff243de0970e66">UCharIteratorMove</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001139">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00399">399</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="c6dc92d309ace93dc07ad9092e807578"></a><!-- doxytag: member="UCharIterator::hasNext" ref="c6dc92d309ace93dc07ad9092e807578" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#8df87a03c91a3e20012949de43c59381">UCharIteratorHasNext</a>* <a class="el" href="structUCharIterator.html#c6dc92d309ace93dc07ad9092e807578">UCharIterator::hasNext</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Check if <a class="el" href="structUCharIterator.html#c247dee1b3e3e6fec6688f9dcb5bc1c6">current()</a> and <a class="el" href="structUCharIterator.html#ae26243728a62e6a13ed2008972afb50">next()</a> can still return another code unit.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#8df87a03c91a3e20012949de43c59381">UCharIteratorHasNext</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001140">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00408">408</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="5a5d536cc7275cdba8b6b2487a4f75a6"></a><!-- doxytag: member="UCharIterator::hasPrevious" ref="5a5d536cc7275cdba8b6b2487a4f75a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#238ebeaecab0965abb28c6732b151ed1">UCharIteratorHasPrevious</a>* <a class="el" href="structUCharIterator.html#5a5d536cc7275cdba8b6b2487a4f75a6">UCharIterator::hasPrevious</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Check if <a class="el" href="structUCharIterator.html#65cd2a527c6abe69a0f37a368ce51cfb">previous()</a> can still return another code unit.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#238ebeaecab0965abb28c6732b151ed1">UCharIteratorHasPrevious</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001141">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00416">416</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="c247dee1b3e3e6fec6688f9dcb5bc1c6"></a><!-- doxytag: member="UCharIterator::current" ref="c247dee1b3e3e6fec6688f9dcb5bc1c6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#e4162b85c1ce61e161e0d6832fb5ae25">UCharIteratorCurrent</a>* <a class="el" href="structUCharIterator.html#c247dee1b3e3e6fec6688f9dcb5bc1c6">UCharIterator::current</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Return the code unit at the current position, or U_SENTINEL if there is none (index is at the limit).
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#e4162b85c1ce61e161e0d6832fb5ae25">UCharIteratorCurrent</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001142">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00425">425</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="ae26243728a62e6a13ed2008972afb50"></a><!-- doxytag: member="UCharIterator::next" ref="ae26243728a62e6a13ed2008972afb50" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#8e9ad76bae5c0639e7c2dde67982ed73">UCharIteratorNext</a>* <a class="el" href="structUCharIterator.html#ae26243728a62e6a13ed2008972afb50">UCharIterator::next</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Return the code unit at the current index and increment the index (post-increment, like s[i++]), or return U_SENTINEL if there is none (index is at the limit).
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#8e9ad76bae5c0639e7c2dde67982ed73">UCharIteratorNext</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001143">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00435">435</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="65cd2a527c6abe69a0f37a368ce51cfb"></a><!-- doxytag: member="UCharIterator::previous" ref="65cd2a527c6abe69a0f37a368ce51cfb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#e84be008356b2c440211befa29f30af0">UCharIteratorPrevious</a>* <a class="el" href="structUCharIterator.html#65cd2a527c6abe69a0f37a368ce51cfb">UCharIterator::previous</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Decrement the index and return the code unit from there (pre-decrement, like s[--i]), or return U_SENTINEL if there is none (index is at the start).
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#e84be008356b2c440211befa29f30af0">UCharIteratorPrevious</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001144">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00445">445</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="94b7ab71aadd2cbafa7394c1102cdf2f"></a><!-- doxytag: member="UCharIterator::reservedFn" ref="94b7ab71aadd2cbafa7394c1102cdf2f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#80d5b61426ccc309c318963ecadd9fe0">UCharIteratorReserved</a>* <a class="el" href="structUCharIterator.html#94b7ab71aadd2cbafa7394c1102cdf2f">UCharIterator::reservedFn</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Reserved for future use.
<p>
Currently NULL.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="uiter_8h.html#80d5b61426ccc309c318963ecadd9fe0">UCharIteratorReserved</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001145">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00453">453</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="dbdac3a7450c4b9344aad58b1e72d1b4"></a><!-- doxytag: member="UCharIterator::getState" ref="dbdac3a7450c4b9344aad58b1e72d1b4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#c89c7dfd00ad111aae63f094cc427b5a">UCharIteratorGetState</a>* <a class="el" href="structUCharIterator.html#dbdac3a7450c4b9344aad58b1e72d1b4">UCharIterator::getState</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Return the state of the iterator, to be restored later with <a class="el" href="structUCharIterator.html#d216d787e1125bc81b49686c7700b52f">setState()</a>.
<p>
This function pointer is NULL if the iterator does not implement it.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>UCharIteratorGet </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001146">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00462">462</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<a class="anchor" name="d216d787e1125bc81b49686c7700b52f"></a><!-- doxytag: member="UCharIterator::setState" ref="d216d787e1125bc81b49686c7700b52f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uiter_8h.html#51424ac3e57c7d9502f84a048186c99a">UCharIteratorSetState</a>* <a class="el" href="structUCharIterator.html#d216d787e1125bc81b49686c7700b52f">UCharIterator::setState</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
(public) Restore the iterator state from the state word from a call to <a class="el" href="structUCharIterator.html#dbdac3a7450c4b9344aad58b1e72d1b4">getState()</a>.
<p>
This function pointer is NULL if the iterator does not implement it.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>UCharIteratorSet </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable001147">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>
Definition at line <a class="el" href="uiter_8h-source.html#l00472">472</a> of file <a class="el" href="uiter_8h-source.html">uiter.h</a>.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="uiter_8h-source.html">uiter.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:48 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
280da2a01a3d16776505ea3f476de84f
>
files
>
367
