<!-- 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: UText Struct 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>UText Struct Reference</h1><!-- doxytag: class="UText" -->
<p><a class="el" href="structUText.html" title="UText struct.">UText</a> struct.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="utext_8h_source.html">utext.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#aa8d7b2a0a7384ea6a01b8228f227db82">magic</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(private) Magic. <a href="#aa8d7b2a0a7384ea6a01b8228f227db82"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a5381d111f35bcaecbfef253f102df792">flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(private) Flags for managing the allocation and freeing of memory associated with this <a class="el" href="structUText.html" title="UText struct.">UText</a>. <a href="#a5381d111f35bcaecbfef253f102df792"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ac36640ce0a7f5c7b8ae243a8f33e93de">providerProperties</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Text provider properties. <a href="#ac36640ce0a7f5c7b8ae243a8f33e93de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a59864b5605f82440de919feba1d64106">sizeOfStruct</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) sizeOfStruct=sizeof(<a class="el" href="structUText.html" title="UText struct.">UText</a>) Allows possible backward compatible extension. <a href="#a59864b5605f82440de919feba1d64106"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a710af36373dd4d00fbd84f4a8429e248">chunkNativeLimit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Native index of the first character position following the current chunk. <a href="#a710af36373dd4d00fbd84f4a8429e248"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a265765aa476617b1b0a9b2f245d6c3f3">extraSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Size in bytes of the extra space (pExtra). <a href="#a265765aa476617b1b0a9b2f245d6c3f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a52dd2b1427fc28e7d98c7e70064cedd5">nativeIndexingLimit</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) The highest chunk offset where native indexing and chunk (UTF-16) indexing correspond. <a href="#a52dd2b1427fc28e7d98c7e70064cedd5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ae57e342eea4d447634b875f5d19cefef">chunkNativeStart</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Native index of the first character in the text chunk. <a href="#ae57e342eea4d447634b875f5d19cefef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a0e634db596b38d898ea1a11d2a40befd">chunkOffset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Current iteration position within the text chunk (UTF-16 buffer). <a href="#a0e634db596b38d898ea1a11d2a40befd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#abc7bb5d202a4812e7f41733fba6ab256">chunkLength</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Length the text chunk (UTF-16 buffer), in UChars. <a href="#abc7bb5d202a4812e7f41733fba6ab256"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ac718cf49b95a1f41926230c8132137f6">chunkContents</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) pointer to a chunk of text in UTF-16 format. <a href="#ac718cf49b95a1f41926230c8132137f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structUTextFuncs.html">UTextFuncs</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ab56053acd8e0e33243359e7aeb44019f">pFuncs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(public) Pointer to Dispatch table for accessing functions for this <a class="el" href="structUText.html" title="UText struct.">UText</a>. <a href="#ab56053acd8e0e33243359e7aeb44019f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a5ca08431f48c474a57220386bab5b876">pExtra</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer to additional space requested by the text provider during the utext_open operation. <a href="#a5ca08431f48c474a57220386bab5b876"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#aeb9fa867f4b29378c34f5841d32db672">context</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer to string or text-containin object or similar. <a href="#aeb9fa867f4b29378c34f5841d32db672"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a1932275255384d6efa47aa0a8c24d60b">p</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer fields available for use by the text provider. <a href="#a1932275255384d6efa47aa0a8c24d60b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#acf46098bfe250ee8acb81356dfacc351">q</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer fields available for use by the text provider. <a href="#acf46098bfe250ee8acb81356dfacc351"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a88cccfe6b055df7e19f210396fec085a">r</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Pointer fields available for use by the text provider. <a href="#a88cccfe6b055df7e19f210396fec085a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ae4eb8619332a016551b683853fb83379">privP</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. <a href="#ae4eb8619332a016551b683853fb83379"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#af8312bce2b8883ace9917ff06d682321">a</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Integer field reserved for use by the text provider. <a href="#af8312bce2b8883ace9917ff06d682321"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a04153242e0ccf6401a0b7d882eda7371">b</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Integer field reserved for use by the text provider. <a href="#a04153242e0ccf6401a0b7d882eda7371"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#af3da19dd26083eaa72169c30b5397d35">c</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">(protected) Integer field reserved for use by the text provider. <a href="#af3da19dd26083eaa72169c30b5397d35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a49c540af1306f66196ae5e9da79254d0">privA</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. <a href="#a49c540af1306f66196ae5e9da79254d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#a91252e56ab96828249a892ec847b61e8">privB</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. <a href="#a91252e56ab96828249a892ec847b61e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structUText.html#ac990399966e1a7812056f0382ed14114">privC</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. <a href="#ac990399966e1a7812056f0382ed14114"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="structUText.html" title="UText struct.">UText</a> struct. </p>
<p>Provides the interface between the generic <a class="el" href="structUText.html" title="UText struct.">UText</a> access code and the <a class="el" href="structUText.html" title="UText struct.">UText</a> provider code that works on specific kinds of text (UTF-8, noncontiguous UTF-16, whatever.)</p>
<p>Applications that are using predefined types of text providers to pass text data to ICU services will have no need to view the internals of the <a class="el" href="structUText.html" title="UText struct.">UText</a> structs that they open.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001978">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01482">1482</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="af8312bce2b8883ace9917ff06d682321"></a><!-- doxytag: member="UText::a" ref="af8312bce2b8883ace9917ff06d682321" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="structUText.html#af8312bce2b8883ace9917ff06d682321">UText::a</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Integer field reserved for use by the text provider. </p>
<p>Not used by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework, or by the client (user) of the <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002011">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01636">1636</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a04153242e0ccf6401a0b7d882eda7371"></a><!-- doxytag: member="UText::b" ref="a04153242e0ccf6401a0b7d882eda7371" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a04153242e0ccf6401a0b7d882eda7371">UText::b</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Integer field reserved for use by the text provider. </p>
<p>Not used by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework, or by the client (user) of the <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002012">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01643">1643</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="af3da19dd26083eaa72169c30b5397d35"></a><!-- doxytag: member="UText::c" ref="af3da19dd26083eaa72169c30b5397d35" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#af3da19dd26083eaa72169c30b5397d35">UText::c</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Integer field reserved for use by the text provider. </p>
<p>Not used by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework, or by the client (user) of the <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002013">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01650">1650</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac718cf49b95a1f41926230c8132137f6"></a><!-- doxytag: member="UText::chunkContents" ref="ac718cf49b95a1f41926230c8132137f6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* <a class="el" href="structUText.html#ac718cf49b95a1f41926230c8132137f6">UText::chunkContents</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) pointer to a chunk of text in UTF-16 format. </p>
<p>May refer either to original storage of the source of the text, or if conversion was required, to a buffer owned by the <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002004">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01576">1576</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="abc7bb5d202a4812e7f41733fba6ab256"></a><!-- doxytag: member="UText::chunkLength" ref="abc7bb5d202a4812e7f41733fba6ab256" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#abc7bb5d202a4812e7f41733fba6ab256">UText::chunkLength</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Length the text chunk (UTF-16 buffer), in UChars. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002003">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01565">1565</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a710af36373dd4d00fbd84f4a8429e248"></a><!-- doxytag: member="UText::chunkNativeLimit" ref="a710af36373dd4d00fbd84f4a8429e248" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="structUText.html#a710af36373dd4d00fbd84f4a8429e248">UText::chunkNativeLimit</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Native index of the first character position following the current chunk. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001998">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01529">1529</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae57e342eea4d447634b875f5d19cefef"></a><!-- doxytag: member="UText::chunkNativeStart" ref="ae57e342eea4d447634b875f5d19cefef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="structUText.html#ae57e342eea4d447634b875f5d19cefef">UText::chunkNativeStart</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Native index of the first character in the text chunk. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002001">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01552">1552</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0e634db596b38d898ea1a11d2a40befd"></a><!-- doxytag: member="UText::chunkOffset" ref="a0e634db596b38d898ea1a11d2a40befd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a0e634db596b38d898ea1a11d2a40befd">UText::chunkOffset</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Current iteration position within the text chunk (UTF-16 buffer). </p>
<p>This is the index to the character that will be returned by <a class="el" href="utext_8h.html#ad4c8e3ba851a3482b2c77cc58cff9ad0" title="Get the code point at the current iteration position of the UText, and advance the...">utext_next32()</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002002">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01559">1559</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="aeb9fa867f4b29378c34f5841d32db672"></a><!-- doxytag: member="UText::context" ref="aeb9fa867f4b29378c34f5841d32db672" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="structUText.html#aeb9fa867f4b29378c34f5841d32db672">UText::context</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Pointer to string or text-containin object or similar. </p>
<p>This is the source of the text that this <a class="el" href="structUText.html" title="UText struct.">UText</a> is wrapping, in a format that is known to the text provider functions. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002007">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01597">1597</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a265765aa476617b1b0a9b2f245d6c3f3"></a><!-- doxytag: member="UText::extraSize" ref="a265765aa476617b1b0a9b2f245d6c3f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a265765aa476617b1b0a9b2f245d6c3f3">UText::extraSize</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Size in bytes of the extra space (pExtra). </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001999">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01535">1535</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5381d111f35bcaecbfef253f102df792"></a><!-- doxytag: member="UText::flags" ref="a5381d111f35bcaecbfef253f102df792" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a5381d111f35bcaecbfef253f102df792">UText::flags</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(private) Flags for managing the allocation and freeing of memory associated with this <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000118">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01503">1503</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa8d7b2a0a7384ea6a01b8228f227db82"></a><!-- doxytag: member="UText::magic" ref="aa8d7b2a0a7384ea6a01b8228f227db82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structUText.html#aa8d7b2a0a7384ea6a01b8228f227db82">UText::magic</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(private) Magic. </p>
<p>Used to help detect when <a class="el" href="structUText.html" title="UText struct.">UText</a> functions are handed invalid or unitialized <a class="el" href="structUText.html" title="UText struct.">UText</a> structs. utext_openXYZ() functions take an initialized, but not necessarily open, <a class="el" href="structUText.html" title="UText struct.">UText</a> struct as an optional fill-in parameter. This magic field is used to check for that initialization. Text provider close functions must NOT clear the magic field because that would prevent reuse of the <a class="el" href="structUText.html" title="UText struct.">UText</a> struct. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000117">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01495">1495</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a52dd2b1427fc28e7d98c7e70064cedd5"></a><!-- doxytag: member="UText::nativeIndexingLimit" ref="a52dd2b1427fc28e7d98c7e70064cedd5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a52dd2b1427fc28e7d98c7e70064cedd5">UText::nativeIndexingLimit</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) The highest chunk offset where native indexing and chunk (UTF-16) indexing correspond. </p>
<p>For UTF-16 sources, value will be equal to chunkLength.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002000">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01544">1544</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1932275255384d6efa47aa0a8c24d60b"></a><!-- doxytag: member="UText::p" ref="a1932275255384d6efa47aa0a8c24d60b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="structUText.html#a1932275255384d6efa47aa0a8c24d60b">UText::p</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Pointer fields available for use by the text provider. </p>
<p>Not used by <a class="el" href="structUText.html" title="UText struct.">UText</a> common code. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002008">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01606">1606</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5ca08431f48c474a57220386bab5b876"></a><!-- doxytag: member="UText::pExtra" ref="a5ca08431f48c474a57220386bab5b876" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="structUText.html#a5ca08431f48c474a57220386bab5b876">UText::pExtra</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Pointer to additional space requested by the text provider during the utext_open operation. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002006">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01589">1589</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab56053acd8e0e33243359e7aeb44019f"></a><!-- doxytag: member="UText::pFuncs" ref="ab56053acd8e0e33243359e7aeb44019f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structUTextFuncs.html">UTextFuncs</a>* <a class="el" href="structUText.html#ab56053acd8e0e33243359e7aeb44019f">UText::pFuncs</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(public) Pointer to Dispatch table for accessing functions for this <a class="el" href="structUText.html" title="UText struct.">UText</a>. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002005">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01582">1582</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49c540af1306f66196ae5e9da79254d0"></a><!-- doxytag: member="UText::privA" ref="a49c540af1306f66196ae5e9da79254d0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t <a class="el" href="structUText.html#a49c540af1306f66196ae5e9da79254d0">UText::privA</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. </p>
<p>This is not to be touched by the text providers. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000120">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01660">1660</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a91252e56ab96828249a892ec847b61e8"></a><!-- doxytag: member="UText::privB" ref="a91252e56ab96828249a892ec847b61e8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a91252e56ab96828249a892ec847b61e8">UText::privB</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. </p>
<p>This is not to be touched by the text providers. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000121">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01666">1666</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac990399966e1a7812056f0382ed14114"></a><!-- doxytag: member="UText::privC" ref="ac990399966e1a7812056f0382ed14114" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#ac990399966e1a7812056f0382ed14114">UText::privC</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. </p>
<p>This is not to be touched by the text providers. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000122">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01672">1672</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae4eb8619332a016551b683853fb83379"></a><!-- doxytag: member="UText::privP" ref="ae4eb8619332a016551b683853fb83379" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="structUText.html#ae4eb8619332a016551b683853fb83379">UText::privP</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Private field reserved for future use by the <a class="el" href="structUText.html" title="UText struct.">UText</a> framework itself. </p>
<p>This is not to be touched by the text providers. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000119">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01625">1625</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac36640ce0a7f5c7b8ae243a8f33e93de"></a><!-- doxytag: member="UText::providerProperties" ref="ac36640ce0a7f5c7b8ae243a8f33e93de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#ac36640ce0a7f5c7b8ae243a8f33e93de">UText::providerProperties</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Text provider properties. </p>
<p>This set of flags is maintainted by the text provider implementation. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001996">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01511">1511</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="acf46098bfe250ee8acb81356dfacc351"></a><!-- doxytag: member="UText::q" ref="acf46098bfe250ee8acb81356dfacc351" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="structUText.html#acf46098bfe250ee8acb81356dfacc351">UText::q</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Pointer fields available for use by the text provider. </p>
<p>Not used by <a class="el" href="structUText.html" title="UText struct.">UText</a> common code. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002009">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01612">1612</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a88cccfe6b055df7e19f210396fec085a"></a><!-- doxytag: member="UText::r" ref="a88cccfe6b055df7e19f210396fec085a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* <a class="el" href="structUText.html#a88cccfe6b055df7e19f210396fec085a">UText::r</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(protected) Pointer fields available for use by the text provider. </p>
<p>Not used by <a class="el" href="structUText.html" title="UText struct.">UText</a> common code. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002010">Stable:</a></b></dt><dd>ICU 3.6 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01618">1618</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59864b5605f82440de919feba1d64106"></a><!-- doxytag: member="UText::sizeOfStruct" ref="a59864b5605f82440de919feba1d64106" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t <a class="el" href="structUText.html#a59864b5605f82440de919feba1d64106">UText::sizeOfStruct</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>(public) sizeOfStruct=sizeof(<a class="el" href="structUText.html" title="UText struct.">UText</a>) Allows possible backward compatible extension. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001997">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="utext_8h_source.html#l01519">1519</a> of file <a class="el" href="utext_8h_source.html">utext.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="utext_8h_source.html">utext.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
>
648
