<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ICU 58.2: ufieldpositer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">ufieldpositer.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: UFieldPositionIterator for use with format APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br />
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br />
</div>
<p><a href="ufieldpositer_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae6dcb81a72e2304609d93ad389c16d19"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a></td></tr>
<tr class="memdesc:ae6dcb81a72e2304609d93ad389c16d19"><td class="mdescLeft"> </td><td class="mdescRight">C typedef for struct UFieldPositionIterator. <a href="#ae6dcb81a72e2304609d93ad389c16d19">More...</a><br /></td></tr>
<tr class="separator:ae6dcb81a72e2304609d93ad389c16d19"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9de994cd080d6eaaab51acd437c9c5a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ufieldpositer_8h.html#a9de994cd080d6eaaab51acd437c9c5a4">ufieldpositer_open</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a9de994cd080d6eaaab51acd437c9c5a4"><td class="mdescLeft"> </td><td class="mdescRight">Open a new, unset UFieldPositionIterator object. <a href="#a9de994cd080d6eaaab51acd437c9c5a4">More...</a><br /></td></tr>
<tr class="separator:a9de994cd080d6eaaab51acd437c9c5a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69c275bd3b52c8c6619d3ac44c756207"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="ufieldpositer_8h.html#a69c275bd3b52c8c6619d3ac44c756207">ufieldpositer_close</a> (<a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> *fpositer)</td></tr>
<tr class="memdesc:a69c275bd3b52c8c6619d3ac44c756207"><td class="mdescLeft"> </td><td class="mdescRight">Close a UFieldPositionIterator object. <a href="#a69c275bd3b52c8c6619d3ac44c756207">More...</a><br /></td></tr>
<tr class="separator:a69c275bd3b52c8c6619d3ac44c756207"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1b8f9ef44181e2865fe8fdab9c50a40"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="ufieldpositer_8h.html#ac1b8f9ef44181e2865fe8fdab9c50a40">ufieldpositer_next</a> (<a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> *fpositer, int32_t *beginIndex, int32_t *endIndex)</td></tr>
<tr class="memdesc:ac1b8f9ef44181e2865fe8fdab9c50a40"><td class="mdescLeft"> </td><td class="mdescRight">Get information for the next field in the formatted string to which this UFieldPositionIterator currently applies, or return a negative value if there are no more fields. <a href="#ac1b8f9ef44181e2865fe8fdab9c50a40">More...</a><br /></td></tr>
<tr class="separator:ac1b8f9ef44181e2865fe8fdab9c50a40"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: UFieldPositionIterator for use with format APIs. </p>
<p>Usage: ufieldpositer_open creates an empty (unset) UFieldPositionIterator. This can be passed to format functions such as <a class="el" href="udat_8h.html#a4bc9d9661c115dcb337803bc89730b3a">udat_formatForFields</a>, which will set it to apply to the fields in a particular formatted string. ufieldpositer_next can then be used to iterate over those fields, providing for each field its type (using values that are specific to the particular format type, such as date or number formats), as well as the start and end positions of the field in the formatted string. A given UFieldPositionIterator can be re-used for different format calls; each such call resets it to apply to that format string. ufieldpositer_close should be called to dispose of the UFieldPositionIterator when it is no longer needed.</p>
<dl class="section see"><dt>See also</dt><dd>FieldPositionIterator </dd></dl>
<p>Definition in file <a class="el" href="ufieldpositer_8h_source.html">ufieldpositer.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ae6dcb81a72e2304609d93ad389c16d19"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> <a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>C typedef for struct UFieldPositionIterator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005199">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
<p>Definition at line <a class="el" href="ufieldpositer_8h_source.html#l00044">44</a> of file <a class="el" href="ufieldpositer_8h_source.html">ufieldpositer.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a69c275bd3b52c8c6619d3ac44c756207"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ufieldpositer_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> * </td>
<td class="paramname"><em>fpositer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a UFieldPositionIterator object. </p>
<p>Once closed it may no longer be used. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fpositer</td><td>A pointer to the UFieldPositionIterator object to close. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005201">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="ac1b8f9ef44181e2865fe8fdab9c50a40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ufieldpositer_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> * </td>
<td class="paramname"><em>fpositer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>beginIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>endIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get information for the next field in the formatted string to which this UFieldPositionIterator currently applies, or return a negative value if there are no more fields. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fpositer</td><td>A pointer to the UFieldPositionIterator object containing iteration state for the format fields. </td></tr>
<tr><td class="paramname">beginIndex</td><td>A pointer to an int32_t to receive information about the start offset of the field in the formatted string (undefined if the function returns a negative value). May be NULL if this information is not needed. </td></tr>
<tr><td class="paramname">endIndex</td><td>A pointer to an int32_t to receive information about the end offset of the field in the formatted string (undefined if the function returns a negative value). May be NULL if this information is not needed. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The field type (non-negative value), or a negative value if there are no more fields for which to provide information. If negative, then any values pointed to by beginIndex and endIndex are undefined.</dd></dl>
<p>The values for field type depend on what type of formatter the UFieldPositionIterator has been set by; for a date formatter, the values from the UDateFormatField enum. For more information, see the descriptions of format functions that take a UFieldPositionIterator* parameter, such as <a class="el" href="udat_8h.html#a4bc9d9661c115dcb337803bc89730b3a">udat_formatForFields</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005202">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
<a class="anchor" id="a9de994cd080d6eaaab51acd437c9c5a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a>* ufieldpositer_open </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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a new, unset UFieldPositionIterator object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an empty (unset) UFieldPositionIterator object, or NULL if an error occurred. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005200">Stable:</a></b></dt><dd>ICU 55 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
