<!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: ulistformatter.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_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">ulistformatter.h</div> </div> </div><!--header--> <div class="contents"> <a href="ulistformatter_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) 2015-2016, 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 ULISTFORMATTER_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define ULISTFORMATTER_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="l00033"></a><span class="lineno"> 33</span> <span class="keyword">struct </span><a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d"> 34</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a> <a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a>; </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <a class="code" href="umachine_8h.html#af3e3799716eaa41e3f49c7bf18c62b98">U_STABLE</a> <a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a>* U_EXPORT2</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <a class="code" href="ulistformatter_8h.html#a84e77b8ec940dbbc5e6399cc3c64bf7c">ulistfmt_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* locale,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</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="l00063"></a><span class="lineno"> 63</span> <a class="code" href="ulistformatter_8h.html#aa0282980b2964116a10efe30907fef2c">ulistfmt_close</a>(<a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a> *listfmt);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#if U_SHOW_CPLUSPLUS_API</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <a class="code" href="localpointer_8h.html#a3030f841466c4bbbd465ac9c4b999549">U_DEFINE_LOCAL_OPEN_POINTER</a>(<a class="code" href="classLocalUListFormatterPointer.html">LocalUListFormatterPointer</a>, <a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a>, <a class="code" href="ulistformatter_8h.html#aa0282980b2964116a10efe30907fef2c">ulistfmt_close</a>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <a class="code" href="umachine_8h.html#a41691e68155dca13bc1f020fa30dac82">U_DRAFT</a> int32_t U_EXPORT2</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <a class="code" href="ulistformatter_8h.html#a1660fdf1739555b2157b56f65db00372">ulistfmt_format</a>(<span class="keyword">const</span> <a class="code" href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a>* listfmt,</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* <span class="keyword">const</span> strings[],</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> int32_t * stringLengths,</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  int32_t stringCount,</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* result,</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  int32_t resultCapacity,</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a>* status);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#endif </span><span class="comment">/* #if !UCONFIG_NO_FORMATTING */</span><span class="preprocessor"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="ulistformatter_8h_html_a84e77b8ec940dbbc5e6399cc3c64bf7c"><div class="ttname"><a href="ulistformatter_8h.html#a84e77b8ec940dbbc5e6399cc3c64bf7c">ulistfmt_open</a></div><div class="ttdeci">UListFormatter * ulistfmt_open(const char *locale, UErrorCode *status)</div><div class="ttdoc">Open a new UListFormatter object using the rules for a given locale. </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="ulistformatter_8h_html_aa0282980b2964116a10efe30907fef2c"><div class="ttname"><a href="ulistformatter_8h.html#aa0282980b2964116a10efe30907fef2c">ulistfmt_close</a></div><div class="ttdeci">void ulistfmt_close(UListFormatter *listfmt)</div><div class="ttdoc">Close a UListFormatter object. </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="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="classLocalUListFormatterPointer_html"><div class="ttname"><a href="classLocalUListFormatterPointer.html">LocalUListFormatterPointer</a></div><div class="ttdoc">"Smart pointer" class, closes a UListFormatter via ulistfmt_close(). </div></div> <div class="ttc" id="ulistformatter_8h_html_a1660fdf1739555b2157b56f65db00372"><div class="ttname"><a href="ulistformatter_8h.html#a1660fdf1739555b2157b56f65db00372">ulistfmt_format</a></div><div class="ttdeci">int32_t ulistfmt_format(const UListFormatter *listfmt, const UChar *const strings[], const int32_t *stringLengths, int32_t stringCount, UChar *result, int32_t resultCapacity, UErrorCode *status)</div><div class="ttdoc">Formats a list of strings using the conventions established for the UListFormatter object...</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="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="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="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 class="ttc" id="ulistformatter_8h_html_a31361ae522dfc4f114ef417724d7649d"><div class="ttname"><a href="ulistformatter_8h.html#a31361ae522dfc4f114ef417724d7649d">UListFormatter</a></div><div class="ttdeci">struct UListFormatter UListFormatter</div><div class="ttdoc">C typedef for struct UListFormatter. </div><div class="ttdef"><b>Definition:</b> <a href="ulistformatter_8h_source.html#l00034">ulistformatter.h:34</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>