File: //opt/alt/alt-nodejs11/root/usr/share/doc/alt-nodejs11-libicu-doc/unumberformatter_8h.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 67.1: unumberformatter.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 67.1
 <span id="projectnumber">67.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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">unumberformatter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C-compatible API for localized number formatting; not recommended for C++.
<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="parseerr_8h_source.html">unicode/parseerr.h</a>"</code><br />
<code>#include "<a class="el" href="ufieldpositer_8h_source.html">unicode/ufieldpositer.h</a>"</code><br />
<code>#include "<a class="el" href="umisc_8h_source.html">unicode/umisc.h</a>"</code><br />
<code>#include "<a class="el" href="uformattedvalue_8h_source.html">unicode/uformattedvalue.h</a>"</code><br />
</div>
<p><a href="unumberformatter_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:a3ff46527ed00aa2fb63dbe731ca38d14"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">UNumberUnitWidth</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a3ff46527ed00aa2fb63dbe731ca38d14">UNumberUnitWidth</a></td></tr>
<tr class="memdesc:a3ff46527ed00aa2fb63dbe731ca38d14"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to render units, including currencies. <a href="unumberformatter_8h.html#a3ff46527ed00aa2fb63dbe731ca38d14">More...</a><br /></td></tr>
<tr class="separator:a3ff46527ed00aa2fb63dbe731ca38d14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7953fce7f2087157fdf3efab4cff17e9"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a7953fce7f2087157fdf3efab4cff17e9">UNumberGroupingStrategy</a></td></tr>
<tr class="memdesc:a7953fce7f2087157fdf3efab4cff17e9"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). <a href="unumberformatter_8h.html#a7953fce7f2087157fdf3efab4cff17e9">More...</a><br /></td></tr>
<tr class="separator:a7953fce7f2087157fdf3efab4cff17e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7824ae96448ade8bf4a69179467a4ad5"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">UNumberSignDisplay</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a7824ae96448ade8bf4a69179467a4ad5">UNumberSignDisplay</a></td></tr>
<tr class="memdesc:a7824ae96448ade8bf4a69179467a4ad5"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to denote positive and negative numbers. <a href="unumberformatter_8h.html#a7824ae96448ade8bf4a69179467a4ad5">More...</a><br /></td></tr>
<tr class="separator:a7824ae96448ade8bf4a69179467a4ad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16fcae79100ada1f65d90b7e0c03a7f1"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">UNumberDecimalSeparatorDisplay</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a16fcae79100ada1f65d90b7e0c03a7f1">UNumberDecimalSeparatorDisplay</a></td></tr>
<tr class="memdesc:a16fcae79100ada1f65d90b7e0c03a7f1"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to render the decimal separator. <a href="unumberformatter_8h.html#a16fcae79100ada1f65d90b7e0c03a7f1">More...</a><br /></td></tr>
<tr class="separator:a16fcae79100ada1f65d90b7e0c03a7f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c1238b2dd08f32f1ea245ece41e71bd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a></td></tr>
<tr class="memdesc:a7c1238b2dd08f32f1ea245ece41e71bd"><td class="mdescLeft"> </td><td class="mdescRight">C-compatible version of <a class="el" href="classicu_1_1number_1_1LocalizedNumberFormatter.html" title="A NumberFormatter that has a locale associated with it; this means .format() methods are available.">icu::number::LocalizedNumberFormatter</a>. <a href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">More...</a><br /></td></tr>
<tr class="separator:a7c1238b2dd08f32f1ea245ece41e71bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d4030bdc4dd1ec4de828bf1bcf4b1b6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a></td></tr>
<tr class="memdesc:a9d4030bdc4dd1ec4de828bf1bcf4b1b6"><td class="mdescLeft"> </td><td class="mdescRight">C-compatible version of <a class="el" href="classicu_1_1number_1_1FormattedNumber.html" title="The result of a number formatting operation.">icu::number::FormattedNumber</a>. <a href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">More...</a><br /></td></tr>
<tr class="separator:a9d4030bdc4dd1ec4de828bf1bcf4b1b6"><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:a5ee613b0f806f558d9ea877aa62a0c3f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">UNumberUnitWidth</a> { <br />
  <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3fa721badced2bb2b04f6c10afaed3bedef">UNUM_UNIT_WIDTH_NARROW</a>
, <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3fad8d8a2f752f8e91c3360c9a5399ef593">UNUM_UNIT_WIDTH_SHORT</a>
, <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3fa21dfe289ee4e87262df9622134ab29db">UNUM_UNIT_WIDTH_FULL_NAME</a>
, <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3fad0ce2ec95aad4c8c32967b9e2f84fcfb">UNUM_UNIT_WIDTH_ISO_CODE</a>
, <br />
  <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3fa1b45ff25f674b915fb1481b30e23eea5">UNUM_UNIT_WIDTH_HIDDEN</a>
, <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3faefbce8f020b12394f6d37b982273a758">UNUM_UNIT_WIDTH_COUNT</a>
<br />
}</td></tr>
<tr class="memdesc:a5ee613b0f806f558d9ea877aa62a0c3f"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to render units, including currencies. <a href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">More...</a><br /></td></tr>
<tr class="separator:a5ee613b0f806f558d9ea877aa62a0c3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af65963668dc167072ff07ee8d844e87e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> { <br />
  <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87eac60d2b94abb99aea4787c2dd367110c0">UNUM_GROUPING_OFF</a>
, <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87ea30ca25de042e6f4fda0fab0551024854">UNUM_GROUPING_MIN2</a>
, <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87ea574af658ab523f91dfe05577d1e7a7f9">UNUM_GROUPING_AUTO</a>
, <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87ea37fb1e6f342dce66f12802a8218b81c4">UNUM_GROUPING_ON_ALIGNED</a>
, <br />
  <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87ea2df6e82442d711199dceebe6df80dbe6">UNUM_GROUPING_THOUSANDS</a>
, <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87ead8dfc5546d9b427968743e004c3ff43c">UNUM_GROUPING_COUNT</a>
<br />
}</td></tr>
<tr class="memdesc:af65963668dc167072ff07ee8d844e87e"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). <a href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">More...</a><br /></td></tr>
<tr class="separator:af65963668dc167072ff07ee8d844e87e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18092ae1533c9c260f01c9dbf25589c9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">UNumberSignDisplay</a> { <br />
  <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a3919ed89463cc89fc7f25cbd9c9e4968">UNUM_SIGN_AUTO</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a1c62fa437fad105b04e5fcbf65167f4a">UNUM_SIGN_ALWAYS</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a54dff733ecf5a488b6176a3de58229f0">UNUM_SIGN_NEVER</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a3fcc7e72482eaa1f71e0a96506cf6ac2">UNUM_SIGN_ACCOUNTING</a>
, <br />
  <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a5bcfdf8a223dd757686edeeda2eca603">UNUM_SIGN_ACCOUNTING_ALWAYS</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9aa9342df5634c3fc780e31553fb561543">UNUM_SIGN_EXCEPT_ZERO</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a21f195d374f2d6b54d2bc84fc60a52fa">UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO</a>
, <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9ae5314fcda9c534ff8c6e686f967a4c54">UNUM_SIGN_COUNT</a>
<br />
}</td></tr>
<tr class="memdesc:a18092ae1533c9c260f01c9dbf25589c9"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to denote positive and negative numbers. <a href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">More...</a><br /></td></tr>
<tr class="separator:a18092ae1533c9c260f01c9dbf25589c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e0fe0c910e360dda5cdad3387e5a0c6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">UNumberDecimalSeparatorDisplay</a> { <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6a93927951d26b124a5557235406f290d6">UNUM_DECIMAL_SEPARATOR_AUTO</a>
, <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6abb6bc9885a6f2bee1795056d215f0522">UNUM_DECIMAL_SEPARATOR_ALWAYS</a>
, <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6a1d1b364e55dcabab30649afbaa200cd0">UNUM_DECIMAL_SEPARATOR_COUNT</a>
}</td></tr>
<tr class="memdesc:a1e0fe0c910e360dda5cdad3387e5a0c6"><td class="mdescLeft"> </td><td class="mdescRight">An enum declaring how to render the decimal separator. <a href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">More...</a><br /></td></tr>
<tr class="separator:a1e0fe0c910e360dda5cdad3387e5a0c6"><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:a29339e144833880bda36fb7c17032698"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a29339e144833880bda36fb7c17032698">unumf_openForSkeletonAndLocale</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *skeleton, int32_t skeletonLen, const char *locale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a29339e144833880bda36fb7c17032698"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new UNumberFormatter for the given skeleton string and locale. <a href="unumberformatter_8h.html#a29339e144833880bda36fb7c17032698">More...</a><br /></td></tr>
<tr class="separator:a29339e144833880bda36fb7c17032698"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9958b10eb0a89c952e307908f848b311"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a9958b10eb0a89c952e307908f848b311">unumf_openForSkeletonAndLocaleWithError</a> (const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *skeleton, int32_t skeletonLen, const char *locale, <a class="el" href="structUParseError.html">UParseError</a> *perror, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a9958b10eb0a89c952e307908f848b311"><td class="mdescLeft"> </td><td class="mdescRight">Like unumf_openForSkeletonAndLocale, but accepts a <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors.">UParseError</a>, which will be populated with the location of a skeleton syntax error if such a syntax error exists. <a href="unumberformatter_8h.html#a9958b10eb0a89c952e307908f848b311">More...</a><br /></td></tr>
<tr class="separator:a9958b10eb0a89c952e307908f848b311"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bd2d297cb2664b4964d25fd41671dad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a5bd2d297cb2664b4964d25fd41671dad">unumf_openResult</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a5bd2d297cb2664b4964d25fd41671dad"><td class="mdescLeft"> </td><td class="mdescRight">Creates an object to hold the result of a UNumberFormatter operation. <a href="unumberformatter_8h.html#a5bd2d297cb2664b4964d25fd41671dad">More...</a><br /></td></tr>
<tr class="separator:a5bd2d297cb2664b4964d25fd41671dad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a459b9313ed05fc98c9cd125eb9c1a625"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a459b9313ed05fc98c9cd125eb9c1a625">unumf_formatInt</a> (const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> *uformatter, int64_t value, <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a459b9313ed05fc98c9cd125eb9c1a625"><td class="mdescLeft"> </td><td class="mdescRight">Uses a UNumberFormatter to format an integer to a UFormattedNumber. <a href="unumberformatter_8h.html#a459b9313ed05fc98c9cd125eb9c1a625">More...</a><br /></td></tr>
<tr class="separator:a459b9313ed05fc98c9cd125eb9c1a625"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5f79e43adc900f07b3ba90b6315944e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#af5f79e43adc900f07b3ba90b6315944e">unumf_formatDouble</a> (const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> *uformatter, double value, <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:af5f79e43adc900f07b3ba90b6315944e"><td class="mdescLeft"> </td><td class="mdescRight">Uses a UNumberFormatter to format a double to a UFormattedNumber. <a href="unumberformatter_8h.html#af5f79e43adc900f07b3ba90b6315944e">More...</a><br /></td></tr>
<tr class="separator:af5f79e43adc900f07b3ba90b6315944e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45fa50a6e0acae9c62b2d777034ae7fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a45fa50a6e0acae9c62b2d777034ae7fe">unumf_formatDecimal</a> (const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> *uformatter, const char *value, int32_t valueLen, <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a45fa50a6e0acae9c62b2d777034ae7fe"><td class="mdescLeft"> </td><td class="mdescRight">Uses a UNumberFormatter to format a decimal number to a UFormattedNumber. <a href="unumberformatter_8h.html#a45fa50a6e0acae9c62b2d777034ae7fe">More...</a><br /></td></tr>
<tr class="separator:a45fa50a6e0acae9c62b2d777034ae7fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acdb74566cf52bcf81693e7b00c6adb91"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#acdb74566cf52bcf81693e7b00c6adb91">unumf_resultAsValue</a> (const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:acdb74566cf52bcf81693e7b00c6adb91"><td class="mdescLeft"> </td><td class="mdescRight">Returns a representation of a UFormattedNumber as a UFormattedValue, which can be subsequently passed to any API requiring that type. <a href="unumberformatter_8h.html#acdb74566cf52bcf81693e7b00c6adb91">More...</a><br /></td></tr>
<tr class="separator:acdb74566cf52bcf81693e7b00c6adb91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72131183633fda6851c35e37ffd821a1"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a72131183633fda6851c35e37ffd821a1">unumf_resultToString</a> (const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *buffer, int32_t bufferCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a72131183633fda6851c35e37ffd821a1"><td class="mdescLeft"> </td><td class="mdescRight">Extracts the result number string out of a UFormattedNumber to a UChar buffer if possible. <a href="unumberformatter_8h.html#a72131183633fda6851c35e37ffd821a1">More...</a><br /></td></tr>
<tr class="separator:a72131183633fda6851c35e37ffd821a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb2f338571744471c47a31de5e9e2600"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#afb2f338571744471c47a31de5e9e2600">unumf_resultNextFieldPosition</a> (const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="structUFieldPosition.html">UFieldPosition</a> *ufpos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:afb2f338571744471c47a31de5e9e2600"><td class="mdescLeft"> </td><td class="mdescRight">Determines the start and end indices of the next occurrence of the given <em>field</em> in the output string. <a href="unumberformatter_8h.html#afb2f338571744471c47a31de5e9e2600">More...</a><br /></td></tr>
<tr class="separator:afb2f338571744471c47a31de5e9e2600"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a334c362939ec87184448d42a1fce196f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a334c362939ec87184448d42a1fce196f">unumf_resultGetAllFieldPositions</a> (const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult, <a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> *ufpositer, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *ec)</td></tr>
<tr class="memdesc:a334c362939ec87184448d42a1fce196f"><td class="mdescLeft"> </td><td class="mdescRight">Populates the given iterator with all fields in the formatted output string. <a href="unumberformatter_8h.html#a334c362939ec87184448d42a1fce196f">More...</a><br /></td></tr>
<tr class="separator:a334c362939ec87184448d42a1fce196f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f47836ca05077fc912ad24e462312c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a6f47836ca05077fc912ad24e462312c6">unumf_close</a> (<a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> *uformatter)</td></tr>
<tr class="memdesc:a6f47836ca05077fc912ad24e462312c6"><td class="mdescLeft"> </td><td class="mdescRight">Releases the UNumberFormatter created by <a class="el" href="unumberformatter_8h.html#a29339e144833880bda36fb7c17032698" title="Creates a new UNumberFormatter for the given skeleton string and locale.">unumf_openForSkeletonAndLocale()</a>. <a href="unumberformatter_8h.html#a6f47836ca05077fc912ad24e462312c6">More...</a><br /></td></tr>
<tr class="separator:a6f47836ca05077fc912ad24e462312c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78f19cef14a2db1a0eb62a8b724eb123"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unumberformatter_8h.html#a78f19cef14a2db1a0eb62a8b724eb123">unumf_closeResult</a> (<a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> *uresult)</td></tr>
<tr class="memdesc:a78f19cef14a2db1a0eb62a8b724eb123"><td class="mdescLeft"> </td><td class="mdescRight">Releases the UFormattedNumber created by <a class="el" href="unumberformatter_8h.html#a5bd2d297cb2664b4964d25fd41671dad" title="Creates an object to hold the result of a UNumberFormatter operation.">unumf_openResult()</a>. <a href="unumberformatter_8h.html#a78f19cef14a2db1a0eb62a8b724eb123">More...</a><br /></td></tr>
<tr class="separator:a78f19cef14a2db1a0eb62a8b724eb123"><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-compatible API for localized number formatting; not recommended for C++. </p>
<p>This is the C-compatible version of the NumberFormatter API introduced in ICU 60. C++ users should include <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">unicode/numberformatter.h</a> and use the proper C++ APIs.</p>
<p>The C API accepts a number skeleton string for specifying the settings for formatting, which covers a very large subset of all possible number formatting features. For more information on number skeleton strings, see <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">unicode/numberformatter.h</a>.</p>
<p>When using UNumberFormatter, which is treated as immutable, the results are exported to a mutable UFormattedNumber object, which you subsequently use for populating your string buffer or iterating over the fields.</p>
<p>Example code: </p><pre>
// Setup:
UErrorCode ec = U_ZERO_ERROR;
UNumberFormatter* uformatter = unumf_openForSkeletonAndLocale(u"precision-integer", -1, "en", &ec);
UFormattedNumber* uresult = unumf_openResult(&ec);
if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(ec)</a>) { return; }
// Format a double:
unumf_formatDouble(uformatter, 5142.3, uresult, &ec);
if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(ec)</a>) { return; }
// Export the string to a malloc'd buffer:
int32_t len = unumf_resultToString(uresult, NULL, 0, &ec);
// at this point, ec == U_BUFFER_OVERFLOW_ERROR
ec = U_ZERO_ERROR;
UChar* buffer = (UChar*) malloc((len+1)*sizeof(UChar));
unumf_resultToString(uresult, buffer, len+1, &ec);
if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(ec)</a>) { return; }
// buffer should equal "5,142"
// Cleanup:
unumf_close(uformatter);
unumf_closeResult(uresult);
free(buffer);
</pre><p>If you are a C++ user linking against the C libraries, you can use the LocalPointer versions of these APIs. The following example uses LocalPointer with the decimal number and field position APIs:</p>
<pre>
// Setup:
<a class="el" href="classLocalUNumberFormatterPointer.html" title=""Smart pointer" class; closes a UNumberFormatter via unumf_close().">LocalUNumberFormatterPointer</a> uformatter(unumf_openForSkeletonAndLocale(u"percent", -1, "en", &ec));
<a class="el" href="classLocalUFormattedNumberPointer.html" title=""Smart pointer" class; closes a UFormattedNumber via unumf_closeResult().">LocalUFormattedNumberPointer</a> uresult(unumf_openResult(&ec));
if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(ec)</a>) { return; }
// Format a decimal number:
unumf_formatDecimal(uformatter.getAlias(), "9.87E-3", -1, uresult.getAlias(), &ec);
if (<a class="el" href="utypes_8h.html#a4d202200b6aa6f3c965ea370e0c8155f" title="Does the error code indicate a failure?">U_FAILURE(ec)</a>) { return; }
// Get the location of the percent sign:
<a class="el" href="structUFieldPosition.html" title="A struct representing a range of text containing a specific field.">UFieldPosition</a> ufpos = {UNUM_PERCENT_FIELD, 0, 0};
unumf_resultNextFieldPosition(uresult.getAlias(), &ufpos, &ec);
// ufpos should contain beginIndex=7 and endIndex=8 since the string is "0.00987%"
// No need to do any cleanup since we are using LocalPointer.
</pre>
<p class="definition">Definition in file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a9d4030bdc4dd1ec4de828bf1bcf4b1b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">◆ </a></span>UFormattedNumber</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>C-compatible version of <a class="el" href="classicu_1_1number_1_1FormattedNumber.html" title="The result of a number formatting operation.">icu::number::FormattedNumber</a>. </p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006223">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00001">1</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<a id="a16fcae79100ada1f65d90b7e0c03a7f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16fcae79100ada1f65d90b7e0c03a7f1">◆ </a></span>UNumberDecimalSeparatorDisplay</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">UNumberDecimalSeparatorDisplay</a> <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">UNumberDecimalSeparatorDisplay</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to render the decimal separator. </p>
<ul>
<li>
UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1" </li>
<li>
UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1" </li>
</ul>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006221">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</div>
</div>
<a id="a7c1238b2dd08f32f1ea245ece41e71bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c1238b2dd08f32f1ea245ece41e71bd">◆ </a></span>UNumberFormatter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>C-compatible version of <a class="el" href="classicu_1_1number_1_1LocalizedNumberFormatter.html" title="A NumberFormatter that has a locale associated with it; this means .format() methods are available.">icu::number::LocalizedNumberFormatter</a>. </p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006222">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00001">1</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<a id="a7953fce7f2087157fdf3efab4cff17e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7953fce7f2087157fdf3efab4cff17e9">◆ </a></span>UNumberGroupingStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a> <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). </p>
<p>The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in <em>en-IN</em>:</p>
<ul>
<li>
OFF: 1234 and 12345 </li>
<li>
MIN2: 1234 and 12,34,567 </li>
<li>
AUTO: 1,234 and 12,34,567 </li>
<li>
ON_ALIGNED: 1,234 and 12,34,567 </li>
<li>
THOUSANDS: 1,234 and 1,234,567 </li>
</ul>
<p>The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.</p>
<p>Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006219">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
</div>
</div>
<a id="a7824ae96448ade8bf4a69179467a4ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7824ae96448ade8bf4a69179467a4ad5">◆ </a></span>UNumberSignDisplay</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">UNumberSignDisplay</a> <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">UNumberSignDisplay</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to denote positive and negative numbers. </p>
<p>Example outputs when formatting 123, 0, and -123 in <em>en-US</em>:</p>
<ul>
<li>
AUTO: "123", "0", and "-123" </li>
<li>
ALWAYS: "+123", "+0", and "-123" </li>
<li>
NEVER: "123", "0", and "123" </li>
<li>
ACCOUNTING: "$123", "$0", and "($123)" </li>
<li>
ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)" </li>
<li>
EXCEPT_ZERO: "+123", "0", and "-123" </li>
<li>
ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)" </li>
</ul>
<p>The exact format, including the position and the code point of the sign, differ by locale.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006220">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</div>
</div>
<a id="a3ff46527ed00aa2fb63dbe731ca38d14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ff46527ed00aa2fb63dbe731ca38d14">◆ </a></span>UNumberUnitWidth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">UNumberUnitWidth</a> <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">UNumberUnitWidth</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to render units, including currencies. </p>
<p>Example outputs when formatting 123 USD and 123 meters in <em>en-CA</em>:</p>
<ul>
<li>
NARROW*: "$123.00" and "123 m" </li>
<li>
SHORT: "US$&nbsp;123.00" and "123 m" </li>
<li>
FULL_NAME: "123.00 US dollars" and "123 meters" </li>
<li>
ISO_CODE: "USD&nbsp;123.00" and undefined behavior </li>
<li>
HIDDEN: "123.00" and "123" </li>
</ul>
<p>This enum is similar to <a class="el" href="measfmt_8h.html#a22ea0f6dd9ebe30a5b9d3f8f439af43f">UMeasureFormatWidth</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006218">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a1e0fe0c910e360dda5cdad3387e5a0c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e0fe0c910e360dda5cdad3387e5a0c6">◆ </a></span>UNumberDecimalSeparatorDisplay</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberformatter_8h.html#a1e0fe0c910e360dda5cdad3387e5a0c6">UNumberDecimalSeparatorDisplay</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to render the decimal separator. </p>
<ul>
<li>
UNUM_DECIMAL_SEPARATOR_AUTO: "1", "1.1" </li>
<li>
UNUM_DECIMAL_SEPARATOR_ALWAYS: "1.", "1.1" </li>
</ul>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006221">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1e0fe0c910e360dda5cdad3387e5a0c6a93927951d26b124a5557235406f290d6"></a>UNUM_DECIMAL_SEPARATOR_AUTO </td><td class="fielddoc"><p>Show the decimal separator when there are one or more digits to display after the separator, and do not show it otherwise. </p>
<p>This is the default behavior.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006253">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a1e0fe0c910e360dda5cdad3387e5a0c6abb6bc9885a6f2bee1795056d215f0522"></a>UNUM_DECIMAL_SEPARATOR_ALWAYS </td><td class="fielddoc"><p>Always show the decimal separator, even if there are no digits to display after the separator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006254">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a1e0fe0c910e360dda5cdad3387e5a0c6a1d1b364e55dcabab30649afbaa200cd0"></a>UNUM_DECIMAL_SEPARATOR_COUNT </td><td class="fielddoc"><p>One more than the highest UNumberDecimalSeparatorDisplay value. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000529">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00373">373</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<a id="af65963668dc167072ff07ee8d844e87e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af65963668dc167072ff07ee8d844e87e">◆ </a></span>UNumberGroupingStrategy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberformatter_8h.html#af65963668dc167072ff07ee8d844e87e">UNumberGroupingStrategy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring the strategy for when and how to display grouping separators (i.e., the separator, often a comma or period, after every 2-3 powers of ten). </p>
<p>The choices are several pre-built strategies for different use cases that employ locale data whenever possible. Example outputs for 1234 and 1234567 in <em>en-IN</em>:</p>
<ul>
<li>
OFF: 1234 and 12345 </li>
<li>
MIN2: 1234 and 12,34,567 </li>
<li>
AUTO: 1,234 and 12,34,567 </li>
<li>
ON_ALIGNED: 1,234 and 12,34,567 </li>
<li>
THOUSANDS: 1,234 and 1,234,567 </li>
</ul>
<p>The default is AUTO, which displays grouping separators unless the locale data says that grouping is not customary. To force grouping for all numbers greater than 1000 consistently across locales, use ON_ALIGNED. On the other hand, to display grouping less frequently than the default, use MIN2 or OFF. See the docs of each option for details.</p>
<p>Note: This enum specifies the strategy for grouping sizes. To set which character to use as the grouping separator, use the "symbols" setter.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006219">Stable:</a></b></dt><dd>ICU 63 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87eac60d2b94abb99aea4787c2dd367110c0"></a>UNUM_GROUPING_OFF </td><td class="fielddoc"><p>Do not display grouping separators in any locale. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006241">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea30ca25de042e6f4fda0fab0551024854"></a>UNUM_GROUPING_MIN2 </td><td class="fielddoc"><p>Display grouping using locale defaults, except do not show grouping on values smaller than 10000 (such that there is a <em>minimum of two digits</em> before the first separator). </p>
<p>Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006242">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea574af658ab523f91dfe05577d1e7a7f9"></a>UNUM_GROUPING_AUTO </td><td class="fielddoc"><p>Display grouping using the default strategy for all locales. </p>
<p>This is the default behavior.</p>
<p>Note that locales may restrict grouping separators to be displayed only on 1 million or greater (for example, ee and hu) or disable grouping altogether (for example, bg currency).</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006243">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea37fb1e6f342dce66f12802a8218b81c4"></a>UNUM_GROUPING_ON_ALIGNED </td><td class="fielddoc"><p>Always display the grouping separator on values of at least 1000. </p>
<p>This option ignores the locale data that restricts or disables grouping, described in MIN2 and AUTO. This option may be useful to normalize the alignment of numbers, such as in a spreadsheet.</p>
<p>Locale data is used to determine whether to separate larger numbers into groups of 2 (customary in South Asia) or groups of 3 (customary in Europe and the Americas).</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006244">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ea2df6e82442d711199dceebe6df80dbe6"></a>UNUM_GROUPING_THOUSANDS </td><td class="fielddoc"><p>Use the Western defaults: groups of 3 and enabled for all numbers 1000 or greater. </p>
<p>Do not use locale data for determining the grouping strategy.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006245">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="af65963668dc167072ff07ee8d844e87ead8dfc5546d9b427968743e004c3ff43c"></a>UNUM_GROUPING_COUNT </td><td class="fielddoc"><p>One more than the highest UNumberGroupingStrategy value. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000527">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 62: The numeric value may change over time; see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00193">193</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<a id="a18092ae1533c9c260f01c9dbf25589c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18092ae1533c9c260f01c9dbf25589c9">◆ </a></span>UNumberSignDisplay</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9">UNumberSignDisplay</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to denote positive and negative numbers. </p>
<p>Example outputs when formatting 123, 0, and -123 in <em>en-US</em>:</p>
<ul>
<li>
AUTO: "123", "0", and "-123" </li>
<li>
ALWAYS: "+123", "+0", and "-123" </li>
<li>
NEVER: "123", "0", and "123" </li>
<li>
ACCOUNTING: "$123", "$0", and "($123)" </li>
<li>
ACCOUNTING_ALWAYS: "+$123", "+$0", and "($123)" </li>
<li>
EXCEPT_ZERO: "+123", "0", and "-123" </li>
<li>
ACCOUNTING_EXCEPT_ZERO: "+$123", "$0", and "($123)" </li>
</ul>
<p>The exact format, including the position and the code point of the sign, differ by locale.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006220">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a3919ed89463cc89fc7f25cbd9c9e4968"></a>UNUM_SIGN_AUTO </td><td class="fielddoc"><p>Show the minus sign on negative numbers, and do not show the sign on positive numbers. </p>
<p>This is the default behavior.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006246">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a1c62fa437fad105b04e5fcbf65167f4a"></a>UNUM_SIGN_ALWAYS </td><td class="fielddoc"><p>Show the minus sign on negative numbers and the plus sign on positive numbers, including zero. </p>
<p>To hide the sign on zero, see <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9aa9342df5634c3fc780e31553fb561543">UNUM_SIGN_EXCEPT_ZERO</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006247">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a54dff733ecf5a488b6176a3de58229f0"></a>UNUM_SIGN_NEVER </td><td class="fielddoc"><p>Do not show the sign on positive or negative numbers. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006248">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a3fcc7e72482eaa1f71e0a96506cf6ac2"></a>UNUM_SIGN_ACCOUNTING </td><td class="fielddoc"><p>Use the locale-dependent accounting format on negative numbers, and do not show the sign on positive numbers. </p>
<p>The accounting format is defined in CLDR and varies by locale; in many Western locales, the format is a pair of parentheses around the number.</p>
<p>Note: Since CLDR defines the accounting format in the monetary context only, this option falls back to the AUTO sign display strategy when formatting without a currency unit. This limitation may be lifted in the future.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006249">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a5bcfdf8a223dd757686edeeda2eca603"></a>UNUM_SIGN_ACCOUNTING_ALWAYS </td><td class="fielddoc"><p>Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers, including zero. </p>
<p>For more information on the accounting format, see the ACCOUNTING sign display strategy. To hide the sign on zero, see <a class="el" href="unumberformatter_8h.html#a18092ae1533c9c260f01c9dbf25589c9a21f195d374f2d6b54d2bc84fc60a52fa">UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006250">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9aa9342df5634c3fc780e31553fb561543"></a>UNUM_SIGN_EXCEPT_ZERO </td><td class="fielddoc"><p>Show the minus sign on negative numbers and the plus sign on positive numbers. </p>
<p>Do not show a sign on zero, numbers that round to zero, or NaN.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006251">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9a21f195d374f2d6b54d2bc84fc60a52fa"></a>UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO </td><td class="fielddoc"><p>Use the locale-dependent accounting format on negative numbers, and show the plus sign on positive numbers. </p>
<p>Do not show a sign on zero, numbers that round to zero, or NaN. For more information on the accounting format, see the ACCOUNTING sign display strategy.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006252">Stable:</a></b></dt><dd>ICU 61 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a18092ae1533c9c260f01c9dbf25589c9ae5314fcda9c534ff8c6e686f967a4c54"></a>UNUM_SIGN_COUNT </td><td class="fielddoc"><p>One more than the highest UNumberSignDisplay value. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000528">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00287">287</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<a id="a5ee613b0f806f558d9ea877aa62a0c3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ee613b0f806f558d9ea877aa62a0c3f">◆ </a></span>UNumberUnitWidth</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="unumberformatter_8h.html#a5ee613b0f806f558d9ea877aa62a0c3f">UNumberUnitWidth</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>An enum declaring how to render units, including currencies. </p>
<p>Example outputs when formatting 123 USD and 123 meters in <em>en-CA</em>:</p>
<ul>
<li>
NARROW*: "$123.00" and "123 m" </li>
<li>
SHORT: "US$&nbsp;123.00" and "123 m" </li>
<li>
FULL_NAME: "123.00 US dollars" and "123 meters" </li>
<li>
ISO_CODE: "USD&nbsp;123.00" and undefined behavior </li>
<li>
HIDDEN: "123.00" and "123" </li>
</ul>
<p>This enum is similar to <a class="el" href="measfmt_8h.html#a22ea0f6dd9ebe30a5b9d3f8f439af43f">UMeasureFormatWidth</a>.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006218">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3fa721badced2bb2b04f6c10afaed3bedef"></a>UNUM_UNIT_WIDTH_NARROW </td><td class="fielddoc"><p>Print an abbreviated version of the unit name. </p>
<p>Similar to SHORT, but always use the shortest available abbreviation or symbol. This option can be used when the context hints at the identity of the unit. For more information on the difference between NARROW and SHORT, see SHORT.</p>
<p>In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤" placeholder for currencies.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006236">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3fad8d8a2f752f8e91c3360c9a5399ef593"></a>UNUM_UNIT_WIDTH_SHORT </td><td class="fielddoc"><p>Print an abbreviated version of the unit name. </p>
<p>Similar to NARROW, but use a slightly wider abbreviation or symbol when there may be ambiguity. This is the default behavior.</p>
<p>For example, in <em>es-US</em>, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form is "{0}°", since Fahrenheit is the customary unit for temperature in that locale.</p>
<p>In CLDR, this option corresponds to the "Short" format for measure units and the "¤" placeholder for currencies.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006237">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3fa21dfe289ee4e87262df9622134ab29db"></a>UNUM_UNIT_WIDTH_FULL_NAME </td><td class="fielddoc"><p>Print the full name of the unit, without any abbreviations. </p>
<p>In CLDR, this option corresponds to the default format for measure units and the "¤¤¤" placeholder for currencies.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006238">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3fad0ce2ec95aad4c8c32967b9e2f84fcfb"></a>UNUM_UNIT_WIDTH_ISO_CODE </td><td class="fielddoc"><p>Use the three-digit ISO XXX code in place of the symbol for displaying currencies. </p>
<p>The behavior of this option is currently undefined for use with measure units.</p>
<p>In CLDR, this option corresponds to the "¤¤" placeholder for currencies.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006239">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3fa1b45ff25f674b915fb1481b30e23eea5"></a>UNUM_UNIT_WIDTH_HIDDEN </td><td class="fielddoc"><p>Format the number according to the specified unit, but do not display the unit. </p>
<p>For currencies, apply monetary symbols and formats as with SHORT, but omit the currency symbol. For measure units, the behavior is equivalent to not specifying the unit at all.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006240">Stable:</a></b></dt><dd>ICU 60 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a5ee613b0f806f558d9ea877aa62a0c3faefbce8f020b12394f6d37b982273a758"></a>UNUM_UNIT_WIDTH_COUNT </td><td class="fielddoc"><p>One more than the highest UNumberUnitWidth value. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000526">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 60: The numeric value may change over time; see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="unumberformatter_8h_source.html#l00098">98</a> of file <a class="el" href="unumberformatter_8h_source.html">unumberformatter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6f47836ca05077fc912ad24e462312c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f47836ca05077fc912ad24e462312c6">◆ </a></span>unumf_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td>
<td class="paramname"><em>uformatter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the UNumberFormatter created by <a class="el" href="unumberformatter_8h.html#a29339e144833880bda36fb7c17032698" title="Creates a new UNumberFormatter for the given skeleton string and locale.">unumf_openForSkeletonAndLocale()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uformatter</td><td>An object created by <a class="el" href="unumberformatter_8h.html#a29339e144833880bda36fb7c17032698" title="Creates a new UNumberFormatter for the given skeleton string and locale.">unumf_openForSkeletonAndLocale()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006234">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a78f19cef14a2db1a0eb62a8b724eb123"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78f19cef14a2db1a0eb62a8b724eb123">◆ </a></span>unumf_closeResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_closeResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the UFormattedNumber created by <a class="el" href="unumberformatter_8h.html#a5bd2d297cb2664b4964d25fd41671dad" title="Creates an object to hold the result of a UNumberFormatter operation.">unumf_openResult()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uresult</td><td>An object created by <a class="el" href="unumberformatter_8h.html#a5bd2d297cb2664b4964d25fd41671dad" title="Creates an object to hold the result of a UNumberFormatter operation.">unumf_openResult()</a>. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006235">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a45fa50a6e0acae9c62b2d777034ae7fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45fa50a6e0acae9c62b2d777034ae7fe">◆ </a></span>unumf_formatDecimal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_formatDecimal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td>
<td class="paramname"><em>uformatter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>valueLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</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>Uses a UNumberFormatter to format a decimal number to a UFormattedNumber. </p>
<p>A string, field position, and other information can be retrieved from the UFormattedNumber.</p>
<p>The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.</p>
<p>The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available at <a href="http://speleotrove.com/decimal">http://speleotrove.com/decimal</a></p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uformatter</td><td>A formatter object created by unumf_openForSkeletonAndLocale or similar. </td></tr>
<tr><td class="paramname">value</td><td>The numeric string to be formatted. </td></tr>
<tr><td class="paramname">valueLen</td><td>The length of the numeric string, or -1 if it is NUL-terminated. </td></tr>
<tr><td class="paramname">uresult</td><td>The object that will be mutated to store the result; see unumf_openResult. </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#_stable006229">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="af5f79e43adc900f07b3ba90b6315944e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5f79e43adc900f07b3ba90b6315944e">◆ </a></span>unumf_formatDouble()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_formatDouble </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td>
<td class="paramname"><em>uformatter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</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>Uses a UNumberFormatter to format a double to a UFormattedNumber. </p>
<p>A string, field position, and other information can be retrieved from the UFormattedNumber.</p>
<p>The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.</p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uformatter</td><td>A formatter object created by unumf_openForSkeletonAndLocale or similar. </td></tr>
<tr><td class="paramname">value</td><td>The number to be formatted. </td></tr>
<tr><td class="paramname">uresult</td><td>The object that will be mutated to store the result; see unumf_openResult. </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#_stable006228">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a459b9313ed05fc98c9cd125eb9c1a625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a459b9313ed05fc98c9cd125eb9c1a625">◆ </a></span>unumf_formatInt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_formatInt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a> * </td>
<td class="paramname"><em>uformatter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</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>Uses a UNumberFormatter to format an integer to a UFormattedNumber. </p>
<p>A string, field position, and other information can be retrieved from the UFormattedNumber.</p>
<p>The UNumberFormatter can be shared between threads. Each thread should have its own local UFormattedNumber, however, for storing the result of the formatting operation.</p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uformatter</td><td>A formatter object created by unumf_openForSkeletonAndLocale or similar. </td></tr>
<tr><td class="paramname">value</td><td>The number to be formatted. </td></tr>
<tr><td class="paramname">uresult</td><td>The object that will be mutated to store the result; see unumf_openResult. </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#_stable006227">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a29339e144833880bda36fb7c17032698"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29339e144833880bda36fb7c17032698">◆ </a></span>unumf_openForSkeletonAndLocale()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a>* unumf_openForSkeletonAndLocale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>skeletonLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</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>Creates a new UNumberFormatter for the given skeleton string and locale. </p>
<p>This is currently the only method for creating a new UNumberFormatter.</p>
<p>Objects of type UNumberFormatter returned by this method are threadsafe.</p>
<p>For more details on skeleton strings, see the documentation in <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a>. For more details on the usage of this API, see the documentation at the top of <a class="el" href="unumberformatter_8h.html" title="C-compatible API for localized number formatting; not recommended for C++.">unumberformatter.h</a>.</p>
<p>NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">skeleton</td><td>The skeleton string, like u"percent precision-integer" </td></tr>
<tr><td class="paramname">skeletonLen</td><td>The number of UChars in the skeleton string, or -1 if it is NUL-terminated. </td></tr>
<tr><td class="paramname">locale</td><td>The NUL-terminated locale ID. </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#_stable006224">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a9958b10eb0a89c952e307908f848b311"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9958b10eb0a89c952e307908f848b311">◆ </a></span>unumf_openForSkeletonAndLocaleWithError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unumberformatter_8h.html#a7c1238b2dd08f32f1ea245ece41e71bd">UNumberFormatter</a>* unumf_openForSkeletonAndLocaleWithError </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>skeletonLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUParseError.html">UParseError</a> * </td>
<td class="paramname"><em>perror</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>Like unumf_openForSkeletonAndLocale, but accepts a <a class="el" href="structUParseError.html" title="A UParseError struct is used to returned detailed information about parsing errors.">UParseError</a>, which will be populated with the location of a skeleton syntax error if such a syntax error exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">skeleton</td><td>The skeleton string, like u"percent precision-integer" </td></tr>
<tr><td class="paramname">skeletonLen</td><td>The number of UChars in the skeleton string, or -1 if it is NUL-terminated. </td></tr>
<tr><td class="paramname">locale</td><td>The NUL-terminated locale ID. </td></tr>
<tr><td class="paramname">perror</td><td>A parse error struct populated if an error occurs when parsing. Can be NULL. If no error occurs, perror->offset will be set to -1. </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#_stable006225">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a5bd2d297cb2664b4964d25fd41671dad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bd2d297cb2664b4964d25fd41671dad">◆ </a></span>unumf_openResult()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a>* unumf_openResult </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 an object to hold the result of a UNumberFormatter operation. </p>
<p>The object can be used repeatedly; it is cleared whenever passed to a format function.</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="stable"><dt><b><a class="el" href="stable.html#_stable006226">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="acdb74566cf52bcf81693e7b00c6adb91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdb74566cf52bcf81693e7b00c6adb91">◆ </a></span>unumf_resultAsValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="uformattedvalue_8h.html#af64a1850f6a746a6130aa79ae7fed97f">UFormattedValue</a>* unumf_resultAsValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</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 representation of a UFormattedNumber as a UFormattedValue, which can be subsequently passed to any API requiring that type. </p>
<p>The returned object is owned by the UFormattedNumber and is valid only as long as the UFormattedNumber is present and unchanged in memory.</p>
<p>You can think of this method as a cast between types.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uresult</td><td>The object containing the formatted string. </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 UFormattedValue owned by the input object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006230">Stable:</a></b></dt><dd>ICU 64 </dd></dl>
</div>
</div>
<a id="a334c362939ec87184448d42a1fce196f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a334c362939ec87184448d42a1fce196f">◆ </a></span>unumf_resultGetAllFieldPositions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void unumf_resultGetAllFieldPositions </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ufieldpositer_8h.html#ae6dcb81a72e2304609d93ad389c16d19">UFieldPositionIterator</a> * </td>
<td class="paramname"><em>ufpositer</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>Populates the given iterator with all fields in the formatted output string. </p>
<p>This allows you to determine the locations of the integer part, fraction part, and sign.</p>
<p>This is an alternative to the more powerful <a class="el" href="uformattedvalue_8h.html#a9a9b8f0f2949756a4ad5da9eda7e06d0">ufmtval_nextPosition</a> API.</p>
<p>If you need information on only one field, use <a class="el" href="uformattedvalue_8h.html#a9a9b8f0f2949756a4ad5da9eda7e06d0">ufmtval_nextPosition</a> or <a class="el" href="unumberformatter_8h.html#afb2f338571744471c47a31de5e9e2600">unumf_resultNextFieldPosition</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uresult</td><td>The object containing the formatted number. </td></tr>
<tr><td class="paramname">ufpositer</td><td>A pointer to a UFieldPositionIterator created by <a class="el" href="ufieldpositer_8h.html#a9de994cd080d6eaaab51acd437c9c5a4">ufieldpositer_open</a>. Iteration information already present in the UFieldPositionIterator is deleted, and the iterator is reset to apply to the fields in the formatted string created by this function call. The field values and indexes returned by <a class="el" href="ufieldpositer_8h.html#ac1b8f9ef44181e2865fe8fdab9c50a40">ufieldpositer_next</a> represent fields denoted by the UNumberFormatFields enum. Fields are not returned in a guaranteed order. Fields cannot overlap, but they may nest. For example, 1234 could format as "1,234" which might consist of a grouping separator field for ',' and an integer field encompassing the entire string. </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#_stable006233">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="afb2f338571744471c47a31de5e9e2600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb2f338571744471c47a31de5e9e2600">◆ </a></span>unumf_resultNextFieldPosition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> unumf_resultNextFieldPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUFieldPosition.html">UFieldPosition</a> * </td>
<td class="paramname"><em>ufpos</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 the start and end indices of the next occurrence of the given <em>field</em> in the output string. </p>
<p>This allows you to determine the locations of, for example, the integer part, fraction part, or symbols.</p>
<p>This is a simpler but less powerful alternative to <a class="el" href="uformattedvalue_8h.html#a9a9b8f0f2949756a4ad5da9eda7e06d0">ufmtval_nextPosition</a>.</p>
<p>If a field occurs just once, calling this method will find that occurrence and return it. If a field occurs multiple times, this method may be called repeatedly with the following pattern:</p>
<pre>
<a class="el" href="structUFieldPosition.html" title="A struct representing a range of text containing a specific field.">UFieldPosition</a> ufpos = {UNUM_GROUPING_SEPARATOR_FIELD, 0, 0};
while (unumf_resultNextFieldPosition(uresult, ufpos, &ec)) {
// do something with ufpos.
}
</pre><p>This method is useful if you know which field to query. If you want all available field position information, use <a class="el" href="unumberformatter_8h.html#a334c362939ec87184448d42a1fce196f" title="Populates the given iterator with all fields in the formatted output string.">unumf_resultGetAllFieldPositions()</a>.</p>
<p>NOTE: All fields of the <a class="el" href="structUFieldPosition.html" title="A struct representing a range of text containing a specific field.">UFieldPosition</a> must be initialized before calling this method.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uresult</td><td>The object containing the formatted number. </td></tr>
<tr><td class="paramname">ufpos</td><td>Input+output variable. On input, the "field" property determines which field to look up, and the "endIndex" property determines where to begin the search. On output, the "beginIndex" field is set to the beginning of the first occurrence of the field after the input "endIndex", and "endIndex" is set to the end of that occurrence of the field (exclusive index). If a field position is not found, the FieldPosition is not changed and the method returns FALSE. </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#_stable006232">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
<a id="a72131183633fda6851c35e37ffd821a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72131183633fda6851c35e37ffd821a1">◆ </a></span>unumf_resultToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t unumf_resultToString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="unumberformatter_8h.html#a9d4030bdc4dd1ec4de828bf1bcf4b1b6">UFormattedNumber</a> * </td>
<td class="paramname"><em>uresult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>bufferCapacity</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>Extracts the result number string out of a UFormattedNumber to a UChar buffer if possible. </p>
<p>If bufferCapacity is greater than the required length, a terminating NUL is written. If bufferCapacity is less than the required length, an error code is set.</p>
<p>Also see ufmtval_getString, which returns a NUL-terminated string: </p><pre class="fragment">int32_t len;
const UChar* str = ufmtval_getString(unumf_resultAsValue(uresult, &ec), &len, &ec);
</pre><p> NOTE: This is a C-compatible API; C++ users should build against <a class="el" href="numberformatter_8h.html" title="C++ API: Library for localized number formatting introduced in ICU 60.">numberformatter.h</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uresult</td><td>The object containing the formatted number. </td></tr>
<tr><td class="paramname">buffer</td><td>Where to save the string output. </td></tr>
<tr><td class="paramname">bufferCapacity</td><td>The number of UChars available in the buffer. </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 required length. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable006231">Stable:</a></b></dt><dd>ICU 62 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>