File: //opt/alt/alt-nodejs18/root/usr/share/doc/alt-nodejs18-libicu-doc/uformattedvalue_8h.html
<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 74.2: i18n/unicode/uformattedvalue.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 74.2
 <span id="projectnumber">74.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_73bc6a9bb617ea1bc89a10aa59ce84e4.html">i18n</a></li><li class="navelem"><a class="el" href="dir_0119ce638985e8a1561a00fdb5f76ff6.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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">uformattedvalue.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Abstract operations for localized strings.
<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="ufieldpositer_8h_source.html">unicode/ufieldpositer.h</a>"</code><br />
</div>
<p><a href="uformattedvalue_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:a2dda4b0393846bfbc0bb31969d45bf98"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">UFieldCategory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a2dda4b0393846bfbc0bb31969d45bf98">UFieldCategory</a></td></tr>
<tr class="memdesc:a2dda4b0393846bfbc0bb31969d45bf98"><td class="mdescLeft"> </td><td class="mdescRight">All possible field categories in ICU. <a href="#a2dda4b0393846bfbc0bb31969d45bf98">More...</a><br /></td></tr>
<tr class="separator:a2dda4b0393846bfbc0bb31969d45bf98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b6f3224e98efca5a2268c19f5b2f4c2"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a></td></tr>
<tr class="memdesc:a4b6f3224e98efca5a2268c19f5b2f4c2"><td class="mdescLeft"> </td><td class="mdescRight">Represents a span of a string containing a given field. <a href="#a4b6f3224e98efca5a2268c19f5b2f4c2">More...</a><br /></td></tr>
<tr class="separator:a4b6f3224e98efca5a2268c19f5b2f4c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af64a1850f6a746a6130aa79ae7fed97f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a></td></tr>
<tr class="memdesc:af64a1850f6a746a6130aa79ae7fed97f"><td class="mdescLeft"> </td><td class="mdescRight">An abstract formatted value: a string with associated field attributes. <a href="#af64a1850f6a746a6130aa79ae7fed97f">More...</a><br /></td></tr>
<tr class="separator:af64a1850f6a746a6130aa79ae7fed97f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3cbae86bf8813a784ebb8c66a477c2d2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">UFieldCategory</a> { <br />
  <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a78409774026a4109bd7445e1d09ff251">UFIELD_CATEGORY_UNDEFINED</a> = 0,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a0ff5fec61f821d9b0d09b200d73ee1f0">UFIELD_CATEGORY_DATE</a>,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2afb7b301b6eecb42a28b904d93307ec4c">UFIELD_CATEGORY_NUMBER</a>,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2aa583048e5e8b000453a8496d28492cb1">UFIELD_CATEGORY_LIST</a>,
<br />
  <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a52b2603860fb269575aaebf31d6e2384">UFIELD_CATEGORY_RELATIVE_DATETIME</a>,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a040b7f4b0ac01118e0b10584166fc80b">UFIELD_CATEGORY_DATE_INTERVAL</a>,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2ad2c3f55d821bf7d499a9f42eb5e05309">UFIELD_CATEGORY_COUNT</a>,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a1d4f1772f2e7ddf84cff9a9698c5e35b">UFIELD_CATEGORY_LIST_SPAN</a> = 0x1000 + UFIELD_CATEGORY_LIST,
<br />
  <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2a06466fb2a54d51e50652a3b61c642a06">UFIELD_CATEGORY_DATE_INTERVAL_SPAN</a> = 0x1000 + UFIELD_CATEGORY_DATE_INTERVAL,
<a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2aa5ca21ee8b4de92deb1402470ed7dab1">UFIELD_CATEGORY_NUMBER_RANGE_SPAN</a> = 0x1000 + UFIELD_CATEGORY_NUMBER
<br />
}</td></tr>
<tr class="memdesc:a3cbae86bf8813a784ebb8c66a477c2d2"><td class="mdescLeft"> </td><td class="mdescRight">All possible field categories in ICU. <a href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">More...</a><br /></td></tr>
<tr class="separator:a3cbae86bf8813a784ebb8c66a477c2d2"><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:a5e959201670f197e3202043f0a5ec07f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a5e959201670f197e3202043f0a5ec07f">ucfpos_open</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a5e959201670f197e3202043f0a5ec07f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new UConstrainedFieldPosition. <a href="#a5e959201670f197e3202043f0a5ec07f">More...</a><br /></td></tr>
<tr class="separator:a5e959201670f197e3202043f0a5ec07f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a747ff521acd91f582ba14cc33a10f449"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a747ff521acd91f582ba14cc33a10f449">ucfpos_reset</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a747ff521acd91f582ba14cc33a10f449"><td class="mdescLeft"> </td><td class="mdescRight">Resets a UConstrainedFieldPosition to its initial state, as if it were newly created. <a href="#a747ff521acd91f582ba14cc33a10f449">More...</a><br /></td></tr>
<tr class="separator:a747ff521acd91f582ba14cc33a10f449"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eb8d61bb897b4993fb27316e8134b3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a3eb8d61bb897b4993fb27316e8134b3a">ucfpos_close</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos)</td></tr>
<tr class="memdesc:a3eb8d61bb897b4993fb27316e8134b3a"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a UConstrainedFieldPosition and releases its memory. <a href="#a3eb8d61bb897b4993fb27316e8134b3a">More...</a><br /></td></tr>
<tr class="separator:a3eb8d61bb897b4993fb27316e8134b3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00a71f06e6fbb901b8c25d830bf74d4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a00a71f06e6fbb901b8c25d830bf74d4a">ucfpos_constrainCategory</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int32_t category, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a00a71f06e6fbb901b8c25d830bf74d4a"><td class="mdescLeft"> </td><td class="mdescRight">Sets a constraint on the field category. <a href="#a00a71f06e6fbb901b8c25d830bf74d4a">More...</a><br /></td></tr>
<tr class="separator:a00a71f06e6fbb901b8c25d830bf74d4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32ef36a477c331f47e655c0d8529c3dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a32ef36a477c331f47e655c0d8529c3dc">ucfpos_constrainField</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int32_t category, int32_t field, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a32ef36a477c331f47e655c0d8529c3dc"><td class="mdescLeft"> </td><td class="mdescRight">Sets a constraint on the category and field. <a href="#a32ef36a477c331f47e655c0d8529c3dc">More...</a><br /></td></tr>
<tr class="separator:a32ef36a477c331f47e655c0d8529c3dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7739c3ad7c38aa4c27840a94bf3d7dbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a7739c3ad7c38aa4c27840a94bf3d7dbd">ucfpos_getCategory</a> (const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a7739c3ad7c38aa4c27840a94bf3d7dbd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the field category for the current position. <a href="#a7739c3ad7c38aa4c27840a94bf3d7dbd">More...</a><br /></td></tr>
<tr class="separator:a7739c3ad7c38aa4c27840a94bf3d7dbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98aeffe6bab2c9049173839e7256955f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a98aeffe6bab2c9049173839e7256955f">ucfpos_getField</a> (const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a98aeffe6bab2c9049173839e7256955f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the field for the current position. <a href="#a98aeffe6bab2c9049173839e7256955f">More...</a><br /></td></tr>
<tr class="separator:a98aeffe6bab2c9049173839e7256955f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3623410afc62fa1fe1bfcf378dc19697"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a3623410afc62fa1fe1bfcf378dc19697">ucfpos_getIndexes</a> (const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int32_t *pStart, int32_t *pLimit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a3623410afc62fa1fe1bfcf378dc19697"><td class="mdescLeft"> </td><td class="mdescRight">Gets the INCLUSIVE start and EXCLUSIVE end index stored for the current position. <a href="#a3623410afc62fa1fe1bfcf378dc19697">More...</a><br /></td></tr>
<tr class="separator:a3623410afc62fa1fe1bfcf378dc19697"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe243961f34e3923a115ac5c44b0743f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#abe243961f34e3923a115ac5c44b0743f">ucfpos_getInt64IterationContext</a> (const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:abe243961f34e3923a115ac5c44b0743f"><td class="mdescLeft"> </td><td class="mdescRight">Gets an int64 that FormattedValue implementations may use for storage. <a href="#abe243961f34e3923a115ac5c44b0743f">More...</a><br /></td></tr>
<tr class="separator:abe243961f34e3923a115ac5c44b0743f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd01f9bdee220378292810f31e3a5c79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#afd01f9bdee220378292810f31e3a5c79">ucfpos_setInt64IterationContext</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int64_t context, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:afd01f9bdee220378292810f31e3a5c79"><td class="mdescLeft"> </td><td class="mdescRight">Sets an int64 that FormattedValue implementations may use for storage. <a href="#afd01f9bdee220378292810f31e3a5c79">More...</a><br /></td></tr>
<tr class="separator:afd01f9bdee220378292810f31e3a5c79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76cbf03cd6466c982a0ea96525b4bba0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a76cbf03cd6466c982a0ea96525b4bba0">ucfpos_matchesField</a> (const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int32_t category, int32_t field, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a76cbf03cd6466c982a0ea96525b4bba0"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a given field should be included given the constraints. <a href="#a76cbf03cd6466c982a0ea96525b4bba0">More...</a><br /></td></tr>
<tr class="separator:a76cbf03cd6466c982a0ea96525b4bba0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84567ced894c9d9b1ed2613d90a1059c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a84567ced894c9d9b1ed2613d90a1059c">ucfpos_setState</a> (<a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, int32_t category, int32_t field, int32_t start, int32_t limit, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a84567ced894c9d9b1ed2613d90a1059c"><td class="mdescLeft"> </td><td class="mdescRight">Sets new values for the primary public getters. <a href="#a84567ced894c9d9b1ed2613d90a1059c">More...</a><br /></td></tr>
<tr class="separator:a84567ced894c9d9b1ed2613d90a1059c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04bd25d05b5efbb40cb2868d8d1c6037"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#a04bd25d05b5efbb40cb2868d8d1c6037">ufmtval_getString</a> (const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> *ufmtval, int32_t *pLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a04bd25d05b5efbb40cb2868d8d1c6037"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the formatted string. <a href="#a04bd25d05b5efbb40cb2868d8d1c6037">More...</a><br /></td></tr>
<tr class="separator:a04bd25d05b5efbb40cb2868d8d1c6037"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc62e7ad87db65ba86e4b72bfb232906"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattedvalue_8h.html#adc62e7ad87db65ba86e4b72bfb232906">ufmtval_nextPosition</a> (const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> *ufmtval, <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> *ucfpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:adc62e7ad87db65ba86e4b72bfb232906"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over field positions in the UFormattedValue. <a href="#adc62e7ad87db65ba86e4b72bfb232906">More...</a><br /></td></tr>
<tr class="separator:adc62e7ad87db65ba86e4b72bfb232906"><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: Abstract operations for localized strings. </p>
<p>This file contains declarations for classes that deal with formatted strings. A number of APIs throughout ICU use these classes for expressing their localized output. </p>
<p class="definition">Definition in file <a class="el" href="uformattedvalue_8h_source.html">uformattedvalue.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a4b6f3224e98efca5a2268c19f5b2f4c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b6f3224e98efca5a2268c19f5b2f4c2">◆ </a></span>UConstrainedFieldPosition</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Represents a span of a string containing a given field. </p>
<p>This struct differs from <a class="el" href="structUFieldPosition.html" title="A struct representing a range of text containing a specific field. ">UFieldPosition</a> in the following ways:</p>
<ol type="1">
<li>It has information on the field category.</li>
<li>It allows you to set constraints to use when iterating over field positions.</li>
<li>It is used for the newer FormattedValue APIs.</li>
</ol>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006370">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uformattedvalue_8h_source.html#l00118">118</a> of file <a class="el" href="uformattedvalue_8h_source.html">uformattedvalue.h</a>.</p>
</div>
</div>
<a id="a2dda4b0393846bfbc0bb31969d45bf98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2dda4b0393846bfbc0bb31969d45bf98">◆ </a></span>UFieldCategory</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">UFieldCategory</a> <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">UFieldCategory</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>All possible field categories in ICU. </p>
<p>Every entry in this enum corresponds to another enum that exists in ICU.</p>
<p>In the APIs that take a UFieldCategory, an int32_t type is used. Field categories having any of the top four bits turned on are reserved as private-use for external APIs implementing FormattedValue. This means that categories 2^28 and higher or below zero (with the highest bit turned on) are private-use and will not be used by ICU in the future.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006369">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="af64a1850f6a746a6130aa79ae7fed97f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af64a1850f6a746a6130aa79ae7fed97f">◆ </a></span>UFormattedValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An abstract formatted value: a string with associated field attributes. </p>
<p>Many formatters format to types compatible with UFormattedValue.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006383">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
<p class="definition">Definition at line <a class="el" href="uformattedvalue_8h_source.html#l00368">368</a> of file <a class="el" href="uformattedvalue_8h_source.html">uformattedvalue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a3cbae86bf8813a784ebb8c66a477c2d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cbae86bf8813a784ebb8c66a477c2d2">◆ </a></span>UFieldCategory</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uformattedvalue_8h.html#a3cbae86bf8813a784ebb8c66a477c2d2">UFieldCategory</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>All possible field categories in ICU. </p>
<p>Every entry in this enum corresponds to another enum that exists in ICU.</p>
<p>In the APIs that take a UFieldCategory, an int32_t type is used. Field categories having any of the top four bits turned on are reserved as private-use for external APIs implementing FormattedValue. This means that categories 2^28 and higher or below zero (with the highest bit turned on) are private-use and will not be used by ICU in the future.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006369">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a78409774026a4109bd7445e1d09ff251"></a>UFIELD_CATEGORY_UNDEFINED </td><td class="fielddoc"><p>For an undefined field category. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006386">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a0ff5fec61f821d9b0d09b200d73ee1f0"></a>UFIELD_CATEGORY_DATE </td><td class="fielddoc"><p>For fields in UDateFormatField (<a class="el" href="udat_8h.html" title="C API: DateFormat. ">udat.h</a>), from ICU 3.0. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006387">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2afb7b301b6eecb42a28b904d93307ec4c"></a>UFIELD_CATEGORY_NUMBER </td><td class="fielddoc"><p>For fields in UNumberFormatFields (<a class="el" href="unum_8h.html" title="C API: Compatibility APIs for number formatting. ">unum.h</a>), from ICU 49. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006388">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2aa583048e5e8b000453a8496d28492cb1"></a>UFIELD_CATEGORY_LIST </td><td class="fielddoc"><p>For fields in UListFormatterField (<a class="el" href="ulistformatter_8h.html" title="C API: Format a list in a locale-appropriate way. ">ulistformatter.h</a>), from ICU 63. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006389">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a52b2603860fb269575aaebf31d6e2384"></a>UFIELD_CATEGORY_RELATIVE_DATETIME </td><td class="fielddoc"><p>For fields in URelativeDateTimeFormatterField (<a class="el" href="ureldatefmt_8h.html" title="C API: URelativeDateTimeFormatter, relative date formatting of unit + numeric offset. ">ureldatefmt.h</a>), from ICU 64. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006390">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a040b7f4b0ac01118e0b10584166fc80b"></a>UFIELD_CATEGORY_DATE_INTERVAL </td><td class="fielddoc"><p>Reserved for possible future fields in UDateIntervalFormatField. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000548">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2ad2c3f55d821bf7d499a9f42eb5e05309"></a>UFIELD_CATEGORY_COUNT </td><td class="fielddoc"><dl class="internal"><dt><b><a class="el" href="internal.html#_internal000549">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a1d4f1772f2e7ddf84cff9a9698c5e35b"></a>UFIELD_CATEGORY_LIST_SPAN </td><td class="fielddoc"><p>Category for spans in a list. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006391">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2a06466fb2a54d51e50652a3b61c642a06"></a>UFIELD_CATEGORY_DATE_INTERVAL_SPAN </td><td class="fielddoc"><p>Category for spans in a date interval. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006392">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3cbae86bf8813a784ebb8c66a477c2d2aa5ca21ee8b4de92deb1402470ed7dab1"></a>UFIELD_CATEGORY_NUMBER_RANGE_SPAN </td><td class="fielddoc"><p>Category for spans in a number range. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006393">Stable:</a></b></dt><dd>ICU 69 </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="uformattedvalue_8h_source.html#l00034">34</a> of file <a class="el" href="uformattedvalue_8h_source.html">uformattedvalue.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3eb8d61bb897b4993fb27316e8134b3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eb8d61bb897b4993fb27316e8134b3a">◆ </a></span>ucfpos_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a UConstrainedFieldPosition and releases its memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006373">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a00a71f06e6fbb901b8c25d830bf74d4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00a71f06e6fbb901b8c25d830bf74d4a">◆ </a></span>ucfpos_constrainCategory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_constrainCategory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>category</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a constraint on the field category. </p>
<p>When this instance of UConstrainedFieldPosition is passed to ufmtval_nextPosition, positions are skipped unless they have the given category.</p>
<p>Any previously set constraints are cleared.</p>
<p>For example, to loop over only the number-related fields: </p><pre class="fragment">UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
ucfpos_constrainCategory(ucfpos, UFIELDCATEGORY_NUMBER_FORMAT, ec);
while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
// handle the number-related field position
}
ucfpos_close(ucfpos);
</pre><p>Changing the constraint while in the middle of iterating over a FormattedValue does not generally have well-defined behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">category</td><td>The field category to fix when iterating. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006374">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a32ef36a477c331f47e655c0d8529c3dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32ef36a477c331f47e655c0d8529c3dc">◆ </a></span>ucfpos_constrainField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_constrainField </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>field</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a constraint on the category and field. </p>
<p>When this instance of UConstrainedFieldPosition is passed to ufmtval_nextPosition, positions are skipped unless they have the given category and field.</p>
<p>Any previously set constraints are cleared.</p>
<p>For example, to loop over all grouping separators: </p><pre class="fragment">UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
ucfpos_constrainField(ucfpos, UFIELDCATEGORY_NUMBER_FORMAT, UNUM_GROUPING_SEPARATOR_FIELD, ec);
while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
// handle the grouping separator position
}
ucfpos_close(ucfpos);
</pre><p>Changing the constraint while in the middle of iterating over a FormattedValue does not generally have well-defined behavior.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">category</td><td>The field category to fix when iterating. </td></tr>
<tr><td class="paramname">field</td><td>The field to fix when iterating. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006375">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a7739c3ad7c38aa4c27840a94bf3d7dbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7739c3ad7c38aa4c27840a94bf3d7dbd">◆ </a></span>ucfpos_getCategory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t ucfpos_getCategory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the field category for the current position. </p>
<p>If a category or field constraint was set, this function returns the constrained category. Otherwise, the return value is well-defined only after ufmtval_nextPosition returns true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The field category saved in the instance. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006376">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a98aeffe6bab2c9049173839e7256955f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98aeffe6bab2c9049173839e7256955f">◆ </a></span>ucfpos_getField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int32_t ucfpos_getField </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the field for the current position. </p>
<p>If a field constraint was set, this function returns the constrained field. Otherwise, the return value is well-defined only after ufmtval_nextPosition returns true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The field saved in the instance. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006377">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a3623410afc62fa1fe1bfcf378dc19697"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3623410afc62fa1fe1bfcf378dc19697">◆ </a></span>ucfpos_getIndexes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_getIndexes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pStart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pLimit</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the INCLUSIVE start and EXCLUSIVE end index stored for the current position. </p>
<p>The output values are well-defined only after ufmtval_nextPosition returns true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">pStart</td><td>Set to the start index saved in the instance. Ignored if nullptr. </td></tr>
<tr><td class="paramname">pLimit</td><td>Set to the end index saved in the instance. Ignored if nullptr. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006378">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="abe243961f34e3923a115ac5c44b0743f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe243961f34e3923a115ac5c44b0743f">◆ </a></span>ucfpos_getInt64IterationContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> int64_t ucfpos_getInt64IterationContext </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an int64 that FormattedValue implementations may use for storage. </p>
<p>The initial value is zero.</p>
<p>Users of FormattedValue should not need to call this method.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current iteration context from ucfpos_setInt64IterationContext. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006379">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a76cbf03cd6466c982a0ea96525b4bba0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76cbf03cd6466c982a0ea96525b4bba0">◆ </a></span>ucfpos_matchesField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ucfpos_matchesField </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>field</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether a given field should be included given the constraints. </p>
<p>Intended to be used by FormattedValue implementations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">category</td><td>The category to test. </td></tr>
<tr><td class="paramname">field</td><td>The field to test. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006381">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a5e959201670f197e3202043f0a5ec07f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e959201670f197e3202043f0a5ec07f">◆ </a></span>ucfpos_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a>* ucfpos_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> * </td>
<td class="paramname"><em>ec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new UConstrainedFieldPosition. </p>
<p>By default, the UConstrainedFieldPosition has no iteration constraints.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new object, or NULL if an error occurs. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006371">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a747ff521acd91f582ba14cc33a10f449"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a747ff521acd91f582ba14cc33a10f449">◆ </a></span>ucfpos_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets a UConstrainedFieldPosition to its initial state, as if it were newly created. </p>
<p>Removes any constraints that may have been set on the instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006372">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="afd01f9bdee220378292810f31e3a5c79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd01f9bdee220378292810f31e3a5c79">◆ </a></span>ucfpos_setInt64IterationContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_setInt64IterationContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>context</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an int64 that FormattedValue implementations may use for storage. </p>
<p>Intended to be used by FormattedValue implementations.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">context</td><td>The new iteration context. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006380">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a84567ced894c9d9b1ed2613d90a1059c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84567ced894c9d9b1ed2613d90a1059c">◆ </a></span>ucfpos_setState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> void ucfpos_setState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>category</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>limit</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets new values for the primary public getters. </p>
<p>Intended to be used by FormattedValue implementations.</p>
<p>It is up to the implementation to ensure that the user-requested constraints are satisfied. This method does not check!</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ucfpos</td><td>The instance of UConstrainedFieldPosition. </td></tr>
<tr><td class="paramname">category</td><td>The new field category. </td></tr>
<tr><td class="paramname">field</td><td>The new field. </td></tr>
<tr><td class="paramname">start</td><td>The new inclusive start index. </td></tr>
<tr><td class="paramname">limit</td><td>The new exclusive end index. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006382">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a04bd25d05b5efbb40cb2868d8d1c6037"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04bd25d05b5efbb40cb2868d8d1c6037">◆ </a></span>ufmtval_getString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ufmtval_getString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> * </td>
<td class="paramname"><em>ufmtval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>pLength</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the formatted string. </p>
<p>The pointer is owned by the UFormattedValue. The return value is valid only as long as the UFormattedValue is present and unchanged in memory.</p>
<p>The return value is NUL-terminated but could contain internal NULs.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ufmtval</td><td>The object containing the formatted string and attributes. </td></tr>
<tr><td class="paramname">pLength</td><td>Output variable for the length of the string. Ignored if NULL. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A NUL-terminated char16 string owned by the UFormattedValue. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006384">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="adc62e7ad87db65ba86e4b72bfb232906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc62e7ad87db65ba86e4b72bfb232906">◆ </a></span>ufmtval_nextPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a676114b1a64bb7c2de15c919a00b28df">U_CAPI</a> <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ufmtval_nextPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> * </td>
<td class="paramname"><em>ufmtval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="uformattedvalue_8h.html#a4b6f3224e98efca5a2268c19f5b2f4c2">UConstrainedFieldPosition</a> * </td>
<td class="paramname"><em>ucfpos</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>ec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over field positions in the UFormattedValue. </p>
<p>This lets you determine the position of specific types of substrings, like a month or a decimal separator.</p>
<p>To loop over all field positions: </p><pre class="fragment">UConstrainedFieldPosition* ucfpos = ucfpos_open(ec);
while (ufmtval_nextPosition(ufmtval, ucfpos, ec)) {
// handle the field position; get information from ucfpos
}
ucfpos_close(ucfpos);
</pre><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ufmtval</td><td>The object containing the formatted string and attributes. </td></tr>
<tr><td class="paramname">ucfpos</td><td>The object used for iteration state; can provide constraints to iterate over only one specific category or field; see ucfpos_constrainCategory and ucfpos_constrainField. </td></tr>
<tr><td class="paramname">ec</td><td>Set if an error occurs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if another position was found; false otherwise. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006385">Stable:</a></b></dt><dd>ICU 64 </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.14
</small></address>
</body>
</html>