<!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: icu::SimpleFormatter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">icu::SimpleFormatter Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Formats simple patterns like "{1} was born in {0}". <a href="classicu_1_1SimpleFormatter.html#details">More...</a></p> <p><code>#include <<a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::SimpleFormatter:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1SimpleFormatter.png" usemap="#icu::SimpleFormatter_map" alt=""/> <map id="icu::SimpleFormatter_map" name="icu::SimpleFormatter_map"> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,126,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a72aba3cff4284687ee3d92531e011dec"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a72aba3cff4284687ee3d92531e011dec">SimpleFormatter</a> ()</td></tr> <tr class="memdesc:a72aba3cff4284687ee3d92531e011dec"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a72aba3cff4284687ee3d92531e011dec">More...</a><br /></td></tr> <tr class="separator:a72aba3cff4284687ee3d92531e011dec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af07411d325720f29c2b6c67b02f046e0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#af07411d325720f29c2b6c67b02f046e0">SimpleFormatter</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr> <tr class="memdesc:af07411d325720f29c2b6c67b02f046e0"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a formatter from the pattern string. <a href="#af07411d325720f29c2b6c67b02f046e0">More...</a><br /></td></tr> <tr class="separator:af07411d325720f29c2b6c67b02f046e0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4b9a8fff3d9a4f8b5f4efaf037849a2d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a4b9a8fff3d9a4f8b5f4efaf037849a2d">SimpleFormatter</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &pattern, int32_t min, int32_t max, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr> <tr class="memdesc:a4b9a8fff3d9a4f8b5f4efaf037849a2d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a formatter from the pattern string. <a href="#a4b9a8fff3d9a4f8b5f4efaf037849a2d">More...</a><br /></td></tr> <tr class="separator:a4b9a8fff3d9a4f8b5f4efaf037849a2d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aec73fe61729d0e88facbf97b4b26dda1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#aec73fe61729d0e88facbf97b4b26dda1">SimpleFormatter</a> (const <a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a> &other)</td></tr> <tr class="memdesc:aec73fe61729d0e88facbf97b4b26dda1"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#aec73fe61729d0e88facbf97b4b26dda1">More...</a><br /></td></tr> <tr class="separator:aec73fe61729d0e88facbf97b4b26dda1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ada9cfebced86bbc32506f04efe735549"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#ada9cfebced86bbc32506f04efe735549">operator=</a> (const <a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a> &other)</td></tr> <tr class="memdesc:ada9cfebced86bbc32506f04efe735549"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ada9cfebced86bbc32506f04efe735549">More...</a><br /></td></tr> <tr class="separator:ada9cfebced86bbc32506f04efe735549"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5b7154e3ed4c120cfab8bb67e93ec7d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a5b7154e3ed4c120cfab8bb67e93ec7d4">~SimpleFormatter</a> ()</td></tr> <tr class="memdesc:a5b7154e3ed4c120cfab8bb67e93ec7d4"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5b7154e3ed4c120cfab8bb67e93ec7d4">More...</a><br /></td></tr> <tr class="separator:a5b7154e3ed4c120cfab8bb67e93ec7d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae120a158c9bd5f38f3964b19960467b5"><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="classicu_1_1SimpleFormatter.html#ae120a158c9bd5f38f3964b19960467b5">applyPattern</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr> <tr class="memdesc:ae120a158c9bd5f38f3964b19960467b5"><td class="mdescLeft"> </td><td class="mdescRight">Changes this object according to the new pattern. <a href="#ae120a158c9bd5f38f3964b19960467b5">More...</a><br /></td></tr> <tr class="separator:ae120a158c9bd5f38f3964b19960467b5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a37a6f2d1910051f7264d60bc9c701299"><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="classicu_1_1SimpleFormatter.html#a37a6f2d1910051f7264d60bc9c701299">applyPatternMinMaxArguments</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &pattern, int32_t min, int32_t max, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode)</td></tr> <tr class="memdesc:a37a6f2d1910051f7264d60bc9c701299"><td class="mdescLeft"> </td><td class="mdescRight">Changes this object according to the new pattern. <a href="#a37a6f2d1910051f7264d60bc9c701299">More...</a><br /></td></tr> <tr class="separator:a37a6f2d1910051f7264d60bc9c701299"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7148098c1830754fbda78dcb6e1cb682"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit</a> () const </td></tr> <tr class="separator:a7148098c1830754fbda78dcb6e1cb682"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6afedf3cf6bff07a53a831f63aa80ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#af6afedf3cf6bff07a53a831f63aa80ab">format</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value0, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr> <tr class="memdesc:af6afedf3cf6bff07a53a831f63aa80ab"><td class="mdescLeft"> </td><td class="mdescRight">Formats the given value, appending to the appendTo builder. <a href="#af6afedf3cf6bff07a53a831f63aa80ab">More...</a><br /></td></tr> <tr class="separator:af6afedf3cf6bff07a53a831f63aa80ab"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a41bed3d54eb2ac594b09137c4142a2d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a41bed3d54eb2ac594b09137c4142a2d0">format</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value0, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value1, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr> <tr class="memdesc:a41bed3d54eb2ac594b09137c4142a2d0"><td class="mdescLeft"> </td><td class="mdescRight">Formats the given values, appending to the appendTo builder. <a href="#a41bed3d54eb2ac594b09137c4142a2d0">More...</a><br /></td></tr> <tr class="separator:a41bed3d54eb2ac594b09137c4142a2d0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad6e7729b220b60b88dd42cb1f29ce179"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#ad6e7729b220b60b88dd42cb1f29ce179">format</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value0, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value1, const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &value2, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr> <tr class="memdesc:ad6e7729b220b60b88dd42cb1f29ce179"><td class="mdescLeft"> </td><td class="mdescRight">Formats the given values, appending to the appendTo builder. <a href="#ad6e7729b220b60b88dd42cb1f29ce179">More...</a><br /></td></tr> <tr class="separator:ad6e7729b220b60b88dd42cb1f29ce179"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a98d2fdab177cc19558ecc45356fc5d37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a98d2fdab177cc19558ecc45356fc5d37">formatAndAppend</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> *const *values, int32_t valuesLength, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &appendTo, int32_t *offsets, int32_t offsetsLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr> <tr class="memdesc:a98d2fdab177cc19558ecc45356fc5d37"><td class="mdescLeft"> </td><td class="mdescRight">Formats the given values, appending to the appendTo string. <a href="#a98d2fdab177cc19558ecc45356fc5d37">More...</a><br /></td></tr> <tr class="separator:a98d2fdab177cc19558ecc45356fc5d37"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8e4ef839bc858ddb2cd7f756f3fa5fd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a8e4ef839bc858ddb2cd7f756f3fa5fd1">formatAndReplace</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> *const *values, int32_t valuesLength, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &result, int32_t *offsets, int32_t offsetsLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &errorCode) const </td></tr> <tr class="memdesc:a8e4ef839bc858ddb2cd7f756f3fa5fd1"><td class="mdescLeft"> </td><td class="mdescRight">Formats the given values, replacing the contents of the result string. <a href="#a8e4ef839bc858ddb2cd7f756f3fa5fd1">More...</a><br /></td></tr> <tr class="separator:a8e4ef839bc858ddb2cd7f756f3fa5fd1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a444744b42800979427e8415a2fc7c87a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1SimpleFormatter.html#a444744b42800979427e8415a2fc7c87a">getTextWithNoArguments</a> () const </td></tr> <tr class="memdesc:a444744b42800979427e8415a2fc7c87a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pattern text with none of the arguments. <a href="#a444744b42800979427e8415a2fc7c87a">More...</a><br /></td></tr> <tr class="separator:a444744b42800979427e8415a2fc7c87a"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Formats simple patterns like "{1} was born in {0}". </p> <p>Minimal subset of <a class="el" href="classicu_1_1MessageFormat.html">MessageFormat</a>; fast, simple, minimal dependencies. Supports only numbered arguments with no type nor style parameters, and formats only string values. Quoting via ASCII apostrophe compatible with ICU <a class="el" href="classicu_1_1MessageFormat.html">MessageFormat</a> default behavior.</p> <p>Factory methods set error codes for syntax errors and for too few or too many arguments/placeholders.</p> <p><a class="el" href="classicu_1_1SimpleFormatter.html" title="Formats simple patterns like "{1} was born in {0}". ">SimpleFormatter</a> objects are thread-safe except for assignment and applying new patterns.</p> <p>Example: </p><pre> UErrorCode errorCode = U_ZERO_ERROR; <a class="el" href="classicu_1_1SimpleFormatter.html" title="Formats simple patterns like "{1} was born in {0}". ">SimpleFormatter</a> fmt("{1} '{born}' in {0}", errorCode); <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> result;</pre><pre>// Output: "paul {born} in england" fmt.format("england", "paul", result, errorCode); </pre><p>This class is not intended for public subclassing.</p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1MessageFormat.html">MessageFormat</a> </dd> <dd> <a class="el" href="messagepattern_8h.html#a56aa1f898bc4cb898a0cb2facb19b258">UMessagePatternApostropheMode</a> </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000003">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00054">54</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a72aba3cff4284687ee3d92531e011dec"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">icu::SimpleFormatter::SimpleFormatter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000004">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00060">60</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div> </div> <a class="anchor" id="af07411d325720f29c2b6c67b02f046e0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">icu::SimpleFormatter::SimpleFormatter </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>pattern</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a formatter from the pattern string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pattern</td><td>The pattern string. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. Set to U_ILLEGAL_ARGUMENT_ERROR for bad argument syntax. </td></tr> </table> </dd> </dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000005">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00071">71</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div> </div> <a class="anchor" id="a4b9a8fff3d9a4f8b5f4efaf037849a2d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">icu::SimpleFormatter::SimpleFormatter </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>pattern</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>min</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>max</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs a formatter from the pattern string. </p> <p>The number of arguments checked against the given limits is the highest argument number plus one, not the number of occurrences of arguments.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pattern</td><td>The pattern string. </td></tr> <tr><td class="paramname">min</td><td>The pattern must have at least this many arguments. </td></tr> <tr><td class="paramname">max</td><td>The pattern must have at most this many arguments. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. Set to U_ILLEGAL_ARGUMENT_ERROR for bad argument syntax and too few or too many arguments. </td></tr> </table> </dd> </dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000006">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00089">89</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div> </div> <a class="anchor" id="aec73fe61729d0e88facbf97b4b26dda1"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">icu::SimpleFormatter::SimpleFormatter </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000007">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00098">98</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div> </div> <a class="anchor" id="a5b7154e3ed4c120cfab8bb67e93ec7d4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::SimpleFormatter::~SimpleFormatter </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destructor. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000009">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ae120a158c9bd5f38f3964b19960467b5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::SimpleFormatter::applyPattern </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>pattern</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Changes this object according to the new pattern. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pattern</td><td>The pattern string. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. Set to U_ILLEGAL_ARGUMENT_ERROR for bad argument syntax. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(errorCode)</a>. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000010">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00123">123</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> <p>References <a class="el" href="umachine_8h_source.html#l00205">INT32_MAX</a>.</p> </div> </div> <a class="anchor" id="a37a6f2d1910051f7264d60bc9c701299"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::SimpleFormatter::applyPatternMinMaxArguments </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>pattern</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>min</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>max</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Changes this object according to the new pattern. </p> <p>The number of arguments checked against the given limits is the highest argument number plus one, not the number of occurrences of arguments.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">pattern</td><td>The pattern string. </td></tr> <tr><td class="paramname">min</td><td>The pattern must have at least this many arguments. </td></tr> <tr><td class="paramname">max</td><td>The pattern must have at most this many arguments. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. Set to U_ILLEGAL_ARGUMENT_ERROR for bad argument syntax and too few or too many arguments. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>TRUE if <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(errorCode)</a>. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000011">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="af6afedf3cf6bff07a53a831f63aa80ab"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::SimpleFormatter::format </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value0</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>appendTo</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Formats the given value, appending to the appendTo builder. </p> <p>The argument value must not be the same object as appendTo. <a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a> must be at most 1.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value0</td><td>Value for argument {0}. </td></tr> <tr><td class="paramname">appendTo</td><td>Gets the formatted pattern and value appended. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>appendTo </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000013">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="a41bed3d54eb2ac594b09137c4142a2d0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::SimpleFormatter::format </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value0</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>appendTo</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Formats the given values, appending to the appendTo builder. </p> <p>An argument value must not be the same object as appendTo. <a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a> must be at most 2.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value0</td><td>Value for argument {0}. </td></tr> <tr><td class="paramname">value1</td><td>Value for argument {1}. </td></tr> <tr><td class="paramname">appendTo</td><td>Gets the formatted pattern and values appended. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>appendTo </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000014">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="ad6e7729b220b60b88dd42cb1f29ce179"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::SimpleFormatter::format </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value0</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>value2</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>appendTo</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Formats the given values, appending to the appendTo builder. </p> <p>An argument value must not be the same object as appendTo. <a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a> must be at most 3.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">value0</td><td>Value for argument {0}. </td></tr> <tr><td class="paramname">value1</td><td>Value for argument {1}. </td></tr> <tr><td class="paramname">value2</td><td>Value for argument {2}. </td></tr> <tr><td class="paramname">appendTo</td><td>Gets the formatted pattern and values appended. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>appendTo </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000015">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="a98d2fdab177cc19558ecc45356fc5d37"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::SimpleFormatter::formatAndAppend </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> *const * </td> <td class="paramname"><em>values</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>valuesLength</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>appendTo</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t * </td> <td class="paramname"><em>offsets</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>offsetsLength</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Formats the given values, appending to the appendTo string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">values</td><td>The argument values. An argument value must not be the same object as appendTo. Can be NULL if valuesLength==<a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a>==0. </td></tr> <tr><td class="paramname">valuesLength</td><td>The length of the values array. Must be at least <a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a>. </td></tr> <tr><td class="paramname">appendTo</td><td>Gets the formatted pattern and values appended. </td></tr> <tr><td class="paramname">offsets</td><td>offsets[i] receives the offset of where values[i] replaced pattern argument {i}. Can be shorter or longer than values. Can be NULL if offsetsLength==0. If there is no {i} in the pattern, then offsets[i] is set to -1. </td></tr> <tr><td class="paramname">offsetsLength</td><td>The length of the offsets array. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>appendTo </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000016">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="a8e4ef839bc858ddb2cd7f756f3fa5fd1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::SimpleFormatter::formatAndReplace </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> *const * </td> <td class="paramname"><em>values</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>valuesLength</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td> <td class="paramname"><em>result</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t * </td> <td class="paramname"><em>offsets</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int32_t </td> <td class="paramname"><em>offsetsLength</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>errorCode</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </div><div class="memdoc"> <p>Formats the given values, replacing the contents of the result string. </p> <p>May optimize by actually appending to the result if it is the same object as the value corresponding to the initial argument in the pattern.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">values</td><td>The argument values. An argument value may be the same object as result. Can be NULL if valuesLength==<a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a>==0. </td></tr> <tr><td class="paramname">valuesLength</td><td>The length of the values array. Must be at least <a class="el" href="classicu_1_1SimpleFormatter.html#a7148098c1830754fbda78dcb6e1cb682">getArgumentLimit()</a>. </td></tr> <tr><td class="paramname">result</td><td>Gets its contents replaced by the formatted pattern and values. </td></tr> <tr><td class="paramname">offsets</td><td>offsets[i] receives the offset of where values[i] replaced pattern argument {i}. Can be shorter or longer than values. Can be NULL if offsetsLength==0. If there is no {i} in the pattern, then offsets[i] is set to -1. </td></tr> <tr><td class="paramname">offsetsLength</td><td>The length of the offsets array. </td></tr> <tr><td class="paramname">errorCode</td><td>ICU error code in/out parameter. Must fulfill U_SUCCESS before the function call. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>result </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000017">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <a class="anchor" id="a7148098c1830754fbda78dcb6e1cb682"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">int32_t icu::SimpleFormatter::getArgumentLimit </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <dl class="section return"><dt>Returns</dt><dd>The max argument number + 1. </dd></dl> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000012">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00149">149</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> </div> </div> <a class="anchor" id="a444744b42800979427e8415a2fc7c87a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> icu::SimpleFormatter::getTextWithNoArguments </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the pattern text with none of the arguments. </p> <p>Like formatting with all-empty string values. </p><dl class="draft"><dt><b><a class="el" href="draft.html#_draft000018">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> <p>Definition at line <a class="el" href="simpleformatter_8h_source.html#l00262">262</a> of file <a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a>.</p> <p>References <a class="el" href="uversion_8h_source.html#l00132">U_NAMESPACE_END</a>.</p> </div> </div> <a class="anchor" id="ada9cfebced86bbc32506f04efe735549"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a>& icu::SimpleFormatter::operator= </td> <td>(</td> <td class="paramtype">const <a class="el" href="classicu_1_1SimpleFormatter.html">SimpleFormatter</a> & </td> <td class="paramname"><em>other</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Assignment operator. </p> <dl class="draft"><dt><b><a class="el" href="draft.html#_draft000008">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 57 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="simpleformatter_8h_source.html">simpleformatter.h</a></li> </ul> </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>