<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: upluralrules.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">upluralrules.h</div> </div> </div><!--header--> <div class="contents"> <a href="upluralrules_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">*****************************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Copyright (C) 2010-2013, International Business Machines</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">*****************************************************************************************</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">*/</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef UPLURALRULES_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define UPLURALRULES_H</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#if !UCONFIG_NO_FORMATTING</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="localpointer_8h.html">unicode/localpointer.h</a>"</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c"> 46</a></span> <span class="keyword">enum</span> <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> {</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5c9970165fa5b953848d6a055061eb07"> 51</a></span>  <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5c9970165fa5b953848d6a055061eb07">UPLURAL_TYPE_CARDINAL</a>,</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5202122d3a4e2ad72d21879a7262aed0"> 56</a></span>  <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5202122d3a4e2ad72d21879a7262aed0">UPLURAL_TYPE_ORDINAL</a>,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#ifndef U_HIDE_DEPRECATED_API</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca94bf640d740f7669175139a6b0978adc"> 62</a></span>  <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca94bf640d740f7669175139a6b0978adc">UPLURAL_TYPE_COUNT</a></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor">#endif // U_HIDE_DEPRECATED_API</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#ae51c4d4f471dc5d984e8fde4b5a2cfdc"> 68</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">struct </span><a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a>;</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36"> 75</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a> <a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a>; </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a>* U_EXPORT2</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <a class="code" href="upluralrules_8h.html#a2118fdf77493a611db487c736c8378d1">uplrules_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *locale, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <a class="code" href="umachine_8h.html#a41691e68155dca13bc1f020fa30dac82">U_DRAFT</a> <a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a>* U_EXPORT2</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <a class="code" href="upluralrules_8h.html#a1495538767c6f957b866792011477c89">uplrules_openForType</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *locale, <a class="code" href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a> type, <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <span class="keywordtype">void</span> U_EXPORT2</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <a class="code" href="upluralrules_8h.html#a5f8f8ef893e446e154f5be80d4f410eb">uplrules_close</a>(<a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a> *uplrules);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <a class="code" href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a>(<a class="code" href="classLocalUPluralRulesPointer.html">LocalUPluralRulesPointer</a>, <a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a>, <a class="code" href="upluralrules_8h.html#a5f8f8ef893e446e154f5be80d4f410eb">uplrules_close</a>);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> int32_t U_EXPORT2</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <a class="code" href="upluralrules_8h.html#ad2e1a8025cca2078e5a303802480540d">uplrules_select</a>(<span class="keyword">const</span> <a class="code" href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a> *uplrules,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">double</span> number,</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *keyword, int32_t capacity,</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status);</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="preprocessor">#endif </span><span class="comment">/* #if !UCONFIG_NO_FORMATTING */</span><span class="preprocessor"></span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="upluralrules_8h_html_a1495538767c6f957b866792011477c89"><div class="ttname"><a href="upluralrules_8h.html#a1495538767c6f957b866792011477c89">uplrules_openForType</a></div><div class="ttdeci">UPluralRules * uplrules_openForType(const char *locale, UPluralType type, UErrorCode *status)</div><div class="ttdoc">Opens a new UPluralRules object using the predefined plural rules for a given locale and the plural t...</div></div> <div class="ttc" id="upluralrules_8h_html_a2118fdf77493a611db487c736c8378d1"><div class="ttname"><a href="upluralrules_8h.html#a2118fdf77493a611db487c736c8378d1">uplrules_open</a></div><div class="ttdeci">UPluralRules * uplrules_open(const char *locale, UErrorCode *status)</div><div class="ttdoc">Opens a new UPluralRules object using the predefined cardinal-number plural rules for a given locale...</div></div> <div class="ttc" id="upluralrules_8h_html_ad2e1a8025cca2078e5a303802480540d"><div class="ttname"><a href="upluralrules_8h.html#ad2e1a8025cca2078e5a303802480540d">uplrules_select</a></div><div class="ttdeci">int32_t uplrules_select(const UPluralRules *uplrules, double number, UChar *keyword, int32_t capacity, UErrorCode *status)</div><div class="ttdoc">Given a number, returns the keyword of the first rule that applies to the number, according to the su...</div></div> <div class="ttc" id="upluralrules_8h_html_a5f8f8ef893e446e154f5be80d4f410eb"><div class="ttname"><a href="upluralrules_8h.html#a5f8f8ef893e446e154f5be80d4f410eb">uplrules_close</a></div><div class="ttdeci">void uplrules_close(UPluralRules *uplrules)</div><div class="ttdoc">Closes a UPluralRules object. </div></div> <div class="ttc" id="uversion_8h_html_a7d9374e037299886d4192b763b4c5e8b"><div class="ttname"><a href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define U_NAMESPACE_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00131">uversion.h:131</a></div></div> <div class="ttc" id="localpointer_8h_html_a3030f841466c4bbbd465ac9c4b999549"><div class="ttname"><a href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a></div><div class="ttdeci">#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)</div><div class="ttdoc">"Smart pointer" definition macro, deletes objects via the closeFunction. </div><div class="ttdef"><b>Definition:</b> <a href="localpointer_8h_source.html#l00530">localpointer.h:530</a></div></div> <div class="ttc" id="upluralrules_8h_html_afceec9f2dee10dbf3ca0d694f66d5d3ca5202122d3a4e2ad72d21879a7262aed0"><div class="ttname"><a href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5202122d3a4e2ad72d21879a7262aed0">UPLURAL_TYPE_ORDINAL</a></div><div class="ttdoc">Plural rules for ordinal numbers: 1st file, 2nd file, 3rd file, 4th file, etc. </div><div class="ttdef"><b>Definition:</b> <a href="upluralrules_8h_source.html#l00056">upluralrules.h:56</a></div></div> <div class="ttc" id="localpointer_8h_html"><div class="ttname"><a href="localpointer_8h.html">localpointer.h</a></div><div class="ttdoc">C++ API: "Smart pointers" for use with and in ICU4C C++ code. </div></div> <div class="ttc" id="upluralrules_8h_html_afceec9f2dee10dbf3ca0d694f66d5d3ca5c9970165fa5b953848d6a055061eb07"><div class="ttname"><a href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca5c9970165fa5b953848d6a055061eb07">UPLURAL_TYPE_CARDINAL</a></div><div class="ttdoc">Plural rules for cardinal numbers: 1 file vs. </div><div class="ttdef"><b>Definition:</b> <a href="upluralrules_8h_source.html#l00051">upluralrules.h:51</a></div></div> <div class="ttc" id="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">uint16_t UChar</div><div class="ttdoc">Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...</div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00337">umachine.h:337</a></div></div> <div class="ttc" id="uversion_8h_html_a3da1f00f3b02976ac53c014a3e4c0933"><div class="ttname"><a href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="ttdeci">#define U_NAMESPACE_END</div><div class="ttdoc">This is used to end a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00132">uversion.h:132</a></div></div> <div class="ttc" id="upluralrules_8h_html_afceec9f2dee10dbf3ca0d694f66d5d3ca94bf640d740f7669175139a6b0978adc"><div class="ttname"><a href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3ca94bf640d740f7669175139a6b0978adc">UPLURAL_TYPE_COUNT</a></div><div class="ttdoc">One more than the highest normal UPluralType value. </div><div class="ttdef"><b>Definition:</b> <a href="upluralrules_8h_source.html#l00062">upluralrules.h:62</a></div></div> <div class="ttc" id="utypes_8h_html_a3343c1c8a8377277046774691c98d78c"><div class="ttname"><a href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a></div><div class="ttdeci">UErrorCode</div><div class="ttdoc">Error code to replace exception handling, so that the code is compatible with all C++ compilers...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00396">utypes.h:396</a></div></div> <div class="ttc" id="upluralrules_8h_html_afceec9f2dee10dbf3ca0d694f66d5d3c"><div class="ttname"><a href="upluralrules_8h.html#afceec9f2dee10dbf3ca0d694f66d5d3c">UPluralType</a></div><div class="ttdeci">UPluralType</div><div class="ttdoc">Type of plurals and PluralRules. </div><div class="ttdef"><b>Definition:</b> <a href="upluralrules_8h_source.html#l00046">upluralrules.h:46</a></div></div> <div class="ttc" id="upluralrules_8h_html_a6fe07aecf6dfa5353e77be6c78e1ff36"><div class="ttname"><a href="upluralrules_8h.html#a6fe07aecf6dfa5353e77be6c78e1ff36">UPluralRules</a></div><div class="ttdeci">struct UPluralRules UPluralRules</div><div class="ttdoc">C typedef for struct UPluralRules. </div><div class="ttdef"><b>Definition:</b> <a href="upluralrules_8h_source.html#l00075">upluralrules.h:75</a></div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> <div class="ttc" id="classLocalUPluralRulesPointer_html"><div class="ttname"><a href="classLocalUPluralRulesPointer.html">LocalUPluralRulesPointer</a></div><div class="ttdoc">"Smart pointer" class, closes a UPluralRules via uplrules_close(). </div></div> <div class="ttc" id="umachine_8h_html_a41691e68155dca13bc1f020fa30dac82"><div class="ttname"><a href="umachine_8h.html#a41691e68155dca13bc1f020fa30dac82">U_DRAFT</a></div><div class="ttdeci">#define U_DRAFT</div><div class="ttdoc">This is used to declare a function as a draft public ICU C API. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00136">umachine.h:136</a></div></div> <div class="ttc" id="umachine_8h_html_af3e3799716eaa41e3f49c7bf18c62b98"><div class="ttname"><a href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a></div><div class="ttdeci">#define U_STABLE</div><div class="ttdoc">This is used to declare a function as a stable public ICU C API. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00134">umachine.h:134</a></div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>