<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: StringEnumeration Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>StringEnumeration Class Reference</h1><!-- doxytag: class="StringEnumeration" --><!-- doxytag: inherits="UObject" -->
<p>Base class for 'pure' C++ implementations of uenum api.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="strenum_8h_source.html">strenum.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for StringEnumeration:</div>
<div class="dynsection">
<div class="center">
<img src="classStringEnumeration.gif" usemap="#StringEnumeration_map" alt=""/>
<map id="StringEnumeration_map" name="StringEnumeration_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,115,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,115,24"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a2782440c508773b1c6474b7d1bc54a01">~StringEnumeration</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2782440c508773b1c6474b7d1bc54a01"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ad4dae9fbf054b06eba3d1a216a8c8580">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clone this object, an instance of a subclass of <a class="el" href="classStringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api.">StringEnumeration</a>. <a href="#ad4dae9fbf054b06eba3d1a216a8c8580"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a1747cfdb3a749c576dbf2a930ff7a010">count</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ae613631e7b63a9987c056ad5b04251e5">next</a> (int32_t *resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a3ea012fc20253a0d97801a1d3cee0fcf">unext</a> (int32_t *resultLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a68de37a3dc40d92679551eacfb02006b">reset</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a13c348b962a621828378624dbab94f29">operator==</a> (const <a class="el" href="classStringEnumeration.html">StringEnumeration</a> &that) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares this enumeration to other to check if both are equal. <a href="#a13c348b962a621828378624dbab94f29"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#aac1c49b98bbae8fc8a16e5d6be11ba4c">operator!=</a> (const <a class="el" href="classStringEnumeration.html">StringEnumeration</a> &that) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compares this enumeration to other to check if both are not equal. <a href="#aac1c49b98bbae8fc8a16e5d6be11ba4c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ac526472a3acff96f58c2b34ffabdacaf">StringEnumeration</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor for use with default implementations and subclasses. <a href="#ac526472a3acff96f58c2b34ffabdacaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ab7428b1c1baf1c9ac4922eca0a7ab636">ensureCharsCapacity</a> (int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ensures that chars is at least as large as the requested capacity. <a href="#ab7428b1c1baf1c9ac4922eca0a7ab636"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a80c0dcfe1fa814cc0d404fe0dbf2b267">setChars</a> (const char *s, int32_t length, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts s to Unicode and sets unistr to the result. <a href="#a80c0dcfe1fa814cc0d404fe0dbf2b267"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ad6e99301df88ba7d1fac67181f98bd2e">unistr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> field for use with default implementations and subclasses. <a href="#ad6e99301df88ba7d1fac67181f98bd2e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#ac6e6a6266dc50407ac399440a136195e">charsBuffer</a> [32]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">char * default buffer for use with default implementations and subclasses. <a href="#ac6e6a6266dc50407ac399440a136195e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#aa91f702f4920744b448ef3b45e957ed7">chars</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">char * buffer for use with default implementations and subclasses. <a href="#aa91f702f4920744b448ef3b45e957ed7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringEnumeration.html#a34d0dc24d6f6ea33fbb5cc9186f03c58">charsCapacity</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Capacity of chars, for use with default implementations and subclasses. <a href="#a34d0dc24d6f6ea33fbb5cc9186f03c58"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Base class for 'pure' C++ implementations of uenum api. </p>
<p>Adds a method that returns the next <a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> since in C++ this can be a common storage format for strings.</p>
<p>The model is that the enumeration is over strings maintained by a 'service.' At any point, the service might change, invalidating the enumerator (though this is expected to be rare). The iterator returns an error if this has occurred. Lack of the error is no guarantee that the service didn't change immediately after the call, so the returned string still might not be 'valid' on subsequent use.</p>
<p>Strings may take the form of const char*, const UChar*, or const UnicodeString*. The type you get is determine by the variant of 'next' that you call. In general the <a class="el" href="classStringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api.">StringEnumeration</a> is optimized for one of these types, but all StringEnumerations can return all types. Returned strings are each terminated with a NUL. Depending on the service data, they might also include embedded NUL characters, so API is provided to optionally return the true length, counting the embedded NULs but not counting the terminating NUL.</p>
<p>The pointers returned by next, unext, and snext become invalid upon any subsequent call to the enumeration's destructor, next, unext, snext, or reset.</p>
<p>ICU 2.8 adds some default implementations and helper functions for subclasses.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000353">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
<p>Definition at line <a class="el" href="strenum_8h_source.html#l00055">55</a> of file <a class="el" href="strenum_8h_source.html">strenum.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2782440c508773b1c6474b7d1bc54a01"></a><!-- doxytag: member="StringEnumeration::~StringEnumeration" ref="a2782440c508773b1c6474b7d1bc54a01" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual StringEnumeration::~StringEnumeration </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000354">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ac526472a3acff96f58c2b34ffabdacaf"></a><!-- doxytag: member="StringEnumeration::StringEnumeration" ref="ac526472a3acff96f58c2b34ffabdacaf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringEnumeration::StringEnumeration </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor for use with default implementations and subclasses. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000367">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad4dae9fbf054b06eba3d1a216a8c8580"></a><!-- doxytag: member="StringEnumeration::clone" ref="ad4dae9fbf054b06eba3d1a216a8c8580" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* StringEnumeration::clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clone this object, an instance of a subclass of <a class="el" href="classStringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api.">StringEnumeration</a>. </p>
<p>Clones can be used concurrently in multiple threads. If a subclass does not implement <a class="el" href="classStringEnumeration.html#ad4dae9fbf054b06eba3d1a216a8c8580" title="Clone this object, an instance of a subclass of StringEnumeration.">clone()</a>, or if an error occurs, then NULL is returned. The clone functions in all subclasses return a base class pointer because some compilers do not support covariant (same-as-this) return types; cast to the appropriate subclass if necessary. The caller must delete the clone.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a clone of this object</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262" title="ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class...">getDynamicClassID</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000355">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a1747cfdb3a749c576dbf2a930ff7a010"></a><!-- doxytag: member="StringEnumeration::count" ref="a1747cfdb3a749c576dbf2a930ff7a010" args="(UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int32_t StringEnumeration::count </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> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of elements that the iterator traverses. If the iterator is out of sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR, and the return value is zero.</p>
<p>The return value will not change except possibly as a result of a subsequent call to reset, or if the iterator becomes out of sync.</p>
<p>This is a convenience function. It can end up being very expensive as all the items might have to be pre-fetched (depending on the storage format of the data being traversed).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of elements in the iterator.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000356">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ab7428b1c1baf1c9ac4922eca0a7ab636"></a><!-- doxytag: member="StringEnumeration::ensureCharsCapacity" ref="ab7428b1c1baf1c9ac4922eca0a7ab636" args="(int32_t capacity, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringEnumeration::ensureCharsCapacity </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ensures that chars is at least as large as the requested capacity. </p>
<p>For use with default implementations and subclasses.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>Requested capacity. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>ICU in/out error code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000368">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="ae613631e7b63a9987c056ad5b04251e5"></a><!-- doxytag: member="StringEnumeration::next" ref="ae613631e7b63a9987c056ad5b04251e5" args="(int32_t *resultLength, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* StringEnumeration::next </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the next element as a NUL-terminated char*. If there are no more elements, returns NULL. If the resultLength pointer is not NULL, the length of the string (not counting the terminating NUL) is returned at that address. If an error status is returned, the value at resultLength is undefined.</p>
<p>The returned pointer is owned by this iterator and must not be deleted by the caller. The pointer is valid until the next call to next, unext, snext, reset, or the enumerator's destructor.</p>
<p>If the iterator is out of sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.</p>
<p>If the native service string is a UChar* string, it is converted to char* with the invariant converter. If the conversion fails (because a character cannot be converted) then status is set to U_INVARIANT_CONVERSION_ERROR and the return value is undefined (though not NULL).</p>
<p>Starting with ICU 2.8, the default implementation calls <a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext()</a> and handles the conversion.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>a pointer to receive the length, can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the string, or NULL.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000357">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="aac1c49b98bbae8fc8a16e5d6be11ba4c"></a><!-- doxytag: member="StringEnumeration::operator!=" ref="aac1c49b98bbae8fc8a16e5d6be11ba4c" args="(const StringEnumeration &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> StringEnumeration::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringEnumeration.html">StringEnumeration</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares this enumeration to other to check if both are not equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td>The other string enumeration to compare this object to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the enumerations are equal. FALSE if not. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000362">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a13c348b962a621828378624dbab94f29"></a><!-- doxytag: member="StringEnumeration::operator==" ref="a13c348b962a621828378624dbab94f29" args="(const StringEnumeration &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> StringEnumeration::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringEnumeration.html">StringEnumeration</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Compares this enumeration to other to check if both are equal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td>The other string enumeration to compare this object to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if the enumerations are equal. FALSE if not. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000361">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
</div>
</div>
<a class="anchor" id="a68de37a3dc40d92679551eacfb02006b"></a><!-- doxytag: member="StringEnumeration::reset" ref="a68de37a3dc40d92679551eacfb02006b" args="(UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void StringEnumeration::reset </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><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Resets the iterator. This re-establishes sync with the service and rewinds the iterator to start at the first element.</p>
<p>Previous pointers returned by next, unext, or snext become invalid, and the value returned by count might change.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code.</td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000360">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a80c0dcfe1fa814cc0d404fe0dbf2b267"></a><!-- doxytag: member="StringEnumeration::setChars" ref="a80c0dcfe1fa814cc0d404fe0dbf2b267" args="(const char *s, int32_t length, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>* StringEnumeration::setChars </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</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"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts s to Unicode and sets unistr to the result. </p>
<p>For use with default implementations and subclasses, especially for implementations of <a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext()</a> in terms of <a class="el" href="classStringEnumeration.html#ae613631e7b63a9987c056ad5b04251e5">next()</a>. This is provided with a helper function instead of a default implementation of <a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext()</a> to avoid potential infinite loops between <a class="el" href="classStringEnumeration.html#ae613631e7b63a9987c056ad5b04251e5">next()</a> and <a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext()</a>.</p>
<p>For example: </p>
<div class="fragment"><pre class="fragment"> <span class="keyword">const</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>* <a class="code" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext</a>(<a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a>& status) {
int32_t resultLength=0;
<span class="keyword">const</span> <span class="keywordtype">char</span> *s=<a class="code" href="classStringEnumeration.html#ae613631e7b63a9987c056ad5b04251e5">next</a>(&resultLength, status);
<span class="keywordflow">return</span> <a class="code" href="classStringEnumeration.html#a80c0dcfe1fa814cc0d404fe0dbf2b267" title="Converts s to Unicode and sets unistr to the result.">setChars</a>(s, resultLength, status);
}
</pre></div><dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>String to be converted to Unicode. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>Length of the string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>ICU in/out error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to unistr. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000369">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a371d8cb385f9602fb41ef356fa425181"></a><!-- doxytag: member="StringEnumeration::snext" ref="a371d8cb385f9602fb41ef356fa425181" args="(UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classUnicodeString.html">UnicodeString</a>* StringEnumeration::snext </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><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the next element a UnicodeString*. If there are no more elements, returns NULL.</p>
<p>The returned pointer is owned by this iterator and must not be deleted by the caller. The pointer is valid until the next call to next, unext, snext, reset, or the enumerator's destructor.</p>
<p>If the iterator is out of sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the string, or NULL.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000359">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a3ea012fc20253a0d97801a1d3cee0fcf"></a><!-- doxytag: member="StringEnumeration::unext" ref="a3ea012fc20253a0d97801a1d3cee0fcf" args="(int32_t *resultLength, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* StringEnumeration::unext </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the next element as a NUL-terminated UChar*. If there are no more elements, returns NULL. If the resultLength pointer is not NULL, the length of the string (not counting the terminating NUL) is returned at that address. If an error status is returned, the value at resultLength is undefined.</p>
<p>The returned pointer is owned by this iterator and must not be deleted by the caller. The pointer is valid until the next call to next, unext, snext, reset, or the enumerator's destructor.</p>
<p>If the iterator is out of sync with its service, status is set to U_ENUM_OUT_OF_SYNC_ERROR and NULL is returned.</p>
<p>Starting with ICU 2.8, the default implementation calls <a class="el" href="classStringEnumeration.html#a371d8cb385f9602fb41ef356fa425181">snext()</a> and handles the conversion.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultLength</em> </td><td>a ponter to receive the length, can be NULL. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the string, or NULL.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000358">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="aa91f702f4920744b448ef3b45e957ed7"></a><!-- doxytag: member="StringEnumeration::chars" ref="aa91f702f4920744b448ef3b45e957ed7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="classStringEnumeration.html#aa91f702f4920744b448ef3b45e957ed7">StringEnumeration::chars</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>char * buffer for use with default implementations and subclasses. </p>
<p>Allocated in constructor and in <a class="el" href="classStringEnumeration.html#ab7428b1c1baf1c9ac4922eca0a7ab636" title="Ensures that chars is at least as large as the requested capacity.">ensureCharsCapacity()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000365">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="strenum_8h_source.html#l00220">220</a> of file <a class="el" href="strenum_8h_source.html">strenum.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac6e6a6266dc50407ac399440a136195e"></a><!-- doxytag: member="StringEnumeration::charsBuffer" ref="ac6e6a6266dc50407ac399440a136195e" args="[32]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="classStringEnumeration.html#ac6e6a6266dc50407ac399440a136195e">StringEnumeration::charsBuffer</a>[32]<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>char * default buffer for use with default implementations and subclasses. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000364">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="strenum_8h_source.html#l00214">214</a> of file <a class="el" href="strenum_8h_source.html">strenum.h</a>.</p>
</div>
</div>
<a class="anchor" id="a34d0dc24d6f6ea33fbb5cc9186f03c58"></a><!-- doxytag: member="StringEnumeration::charsCapacity" ref="a34d0dc24d6f6ea33fbb5cc9186f03c58" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="classStringEnumeration.html#a34d0dc24d6f6ea33fbb5cc9186f03c58">StringEnumeration::charsCapacity</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Capacity of chars, for use with default implementations and subclasses. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000366">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="strenum_8h_source.html#l00225">225</a> of file <a class="el" href="strenum_8h_source.html">strenum.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad6e99301df88ba7d1fac67181f98bd2e"></a><!-- doxytag: member="StringEnumeration::unistr" ref="ad6e99301df88ba7d1fac67181f98bd2e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> <a class="el" href="classStringEnumeration.html#ad6e99301df88ba7d1fac67181f98bd2e">StringEnumeration::unistr</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> field for use with default implementations and subclasses. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000363">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
<p>Definition at line <a class="el" href="strenum_8h_source.html#l00209">209</a> of file <a class="el" href="strenum_8h_source.html">strenum.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="strenum_8h_source.html">strenum.h</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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
192
