<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: MessageFormat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>MessageFormat Class Reference</h1><!-- doxytag: class="MessageFormat" --><!-- doxytag: inherits="Format" -->
<p><a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> produces concatenated messages in a language-neutral way.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="msgfmt_8h_source.html">msgfmt.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for MessageFormat:</div>
<div class="dynsection">
<div class="center">
<img src="classMessageFormat.gif" usemap="#MessageFormat_map" alt=""/>
<map id="MessageFormat_map" name="MessageFormat_map">
<area href="classFormat.html" alt="Format" shape="rect" coords="0,112,102,136"/>
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,102,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,102,24"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a3b02759e9345bba433598ca169fe2626">EFormatNumber</a> { <a class="el" href="classMessageFormat.html#a3b02759e9345bba433598ca169fe2626a2c4649766d55fba1106595c70fab6a79">kMaxFormat</a> = 10
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Enum type for kMaxFormat. </p>
<a href="classMessageFormat.html#a3b02759e9345bba433598ca169fe2626">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a9bd166332a223bf4f626bd4a23826da2">MessageFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and the default locale. <a href="#a9bd166332a223bf4f626bd4a23826da2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a09d0a688a0017c803eb903b5956de3a0">MessageFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, const <a class="el" href="classLocale.html">Locale</a> &newLocale, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and locale. <a href="#a09d0a688a0017c803eb903b5956de3a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#adf000f6a8019f6e9999d3df283688843">MessageFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, const <a class="el" href="classLocale.html">Locale</a> &newLocale, <a class="el" href="structUParseError.html">UParseError</a> &parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and locale. <a href="#adf000f6a8019f6e9999d3df283688843"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a945eac8450aca382e2db73b7c3187249">MessageFormat</a> (const <a class="el" href="classMessageFormat.html">MessageFormat</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> from an existing one. <a href="#a945eac8450aca382e2db73b7c3187249"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classMessageFormat.html">MessageFormat</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a48e4814289b48723b11e7cd00df0be69">operator=</a> (const <a class="el" href="classMessageFormat.html">MessageFormat</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a48e4814289b48723b11e7cd00df0be69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a37bc94ae7e3622880f9f79d58320796b">~MessageFormat</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a37bc94ae7e3622880f9f79d58320796b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFormat.html">Format</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#abe6a3b6d9e7e74b7586b4644e4ba001c">clone</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clones this <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object polymorphically. <a href="#abe6a3b6d9e7e74b7586b4644e4ba001c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a26e0c92e8035193f110b578381611c02">operator==</a> (const <a class="el" href="classFormat.html">Format</a> &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are semantically equal. <a href="#a26e0c92e8035193f110b578381611c02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a5d403deba6c059ebd752d964ad49a7c1">setLocale</a> (const <a class="el" href="classLocale.html">Locale</a> &theLocale)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the locale. <a href="#a5d403deba6c059ebd752d964ad49a7c1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classLocale.html">Locale</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a422910b60d0e79cf37afa8a49418333b">getLocale</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the locale. <a href="#a422910b60d0e79cf37afa8a49418333b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ace3d4f8c18ba0b07aada0066efb9ab9d">applyPattern</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies the given pattern string to this message format. <a href="#ace3d4f8c18ba0b07aada0066efb9ab9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ad5e44f1a945520eefade9b60350a3327">applyPattern</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="structUParseError.html">UParseError</a> &parseError, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Applies the given pattern string to this message format. <a href="#ad5e44f1a945520eefade9b60350a3327"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a96ffcd9c8df9b1a4b9bf604faa51eef2">toPattern</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pattern that can be used to recreate this object. <a href="#a96ffcd9c8df9b1a4b9bf604faa51eef2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a4322393c6960d0abbecb97e2d5db7032">adoptFormats</a> (<a class="el" href="classFormat.html">Format</a> **formatsToAdopt, int32_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets subformats. <a href="#a4322393c6960d0abbecb97e2d5db7032"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a7d51d28b509a3d1365b250be805556a8">setFormats</a> (const <a class="el" href="classFormat.html">Format</a> **newFormats, int32_t cnt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets subformats. <a href="#a7d51d28b509a3d1365b250be805556a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a96f9fb97e9bc525197b39222aba74bcc">adoptFormat</a> (int32_t formatNumber, <a class="el" href="classFormat.html">Format</a> *formatToAdopt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets one subformat. <a href="#a96f9fb97e9bc525197b39222aba74bcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a16530e29c89c9a569d973b0e5f0fc598">setFormat</a> (int32_t formatNumber, const <a class="el" href="classFormat.html">Format</a> &format)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets one subformat. <a href="#a16530e29c89c9a569d973b0e5f0fc598"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a4767de0a57c55c404db332be67edb73e">getFormatNames</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets format names. <a href="#a4767de0a57c55c404db332be67edb73e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFormat.html">Format</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#aaa4cef286b4f4f5845ed783e079ad96b">getFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &formatName, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets subformat pointer for given format name. <a href="#aaa4cef286b4f4f5845ed783e079ad96b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a781ee11f6a1512717b670b6e0db229d9">setFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &formatName, const <a class="el" href="classFormat.html">Format</a> &format, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets one subformat for given format name. <a href="#a781ee11f6a1512717b670b6e0db229d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ab1f5fd9a8e07a97020fe8618fed368b4">adoptFormat</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &formatName, <a class="el" href="classFormat.html">Format</a> *formatToAdopt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets one subformat for given format name. <a href="#ab1f5fd9a8e07a97020fe8618fed368b4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classFormat.html">Format</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ae6fab4bde713f7c17f12c8a6dc9ce89b">getFormats</a> (int32_t &count) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets an array of subformats of this object. <a href="#ae6fab4bde713f7c17f12c8a6dc9ce89b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ac984e47d8f99db7f623bd60f856f8666">format</a> (const <a class="el" href="classFormattable.html">Formattable</a> *source, int32_t count, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="classFieldPosition.html">FieldPosition</a> &ignore, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the given array of arguments into a user-readable string. <a href="#ac984e47d8f99db7f623bd60f856f8666"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a427aef9177f57f8c1fd37c3a3d157437">format</a> (const <a class="el" href="classFormattable.html">Formattable</a> &obj, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="classFieldPosition.html">FieldPosition</a> &pos, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the given array of arguments into a user-readable string. <a href="#a427aef9177f57f8c1fd37c3a3d157437"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a7e78ae8192e0889a196b0b4ae86a3a6a">format</a> (const <a class="el" href="classFormattable.html">Formattable</a> &obj, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the given array of arguments into a user-readable string. <a href="#a7e78ae8192e0889a196b0b4ae86a3a6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a8fd632cd6603981f64301fca9bb15eec">format</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> *argumentNames, const <a class="el" href="classFormattable.html">Formattable</a> *arguments, int32_t count, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the given array of arguments into a user-defined argument name array. <a href="#a8fd632cd6603981f64301fca9bb15eec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFormattable.html">Formattable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ad9f1ebf28e194700db6fef7c16009ea5">parse</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="classParsePosition.html">ParsePosition</a> &pos, int32_t &count) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string into an array of output arguments. <a href="#ad9f1ebf28e194700db6fef7c16009ea5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classFormattable.html">Formattable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#ac4eeb461355c2d0f7c5a76c1d640eefd">parse</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, int32_t &count, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string into an array of output arguments. <a href="#ac4eeb461355c2d0f7c5a76c1d640eefd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a53732066584f68579adf8bf91409217c">parseObject</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &source, <a class="el" href="classFormattable.html">Formattable</a> &result, <a class="el" href="classParsePosition.html">ParsePosition</a> &pos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses the given string into an array of output arguments stored within a single <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> of type kArray. <a href="#a53732066584f68579adf8bf91409217c"></a><br/></td></tr>
<tr><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="classMessageFormat.html#a40b7cb584ce76b7bc3be2289a48c9f96">usesNamedArguments</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> uses named arguments, and false otherwise. <a href="#a40b7cb584ce76b7bc3be2289a48c9f96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a6e9db2c78e0488dd78130dc4eb6fe81a">getArgTypeCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This API is for ICU internal use only. <a href="#a6e9db2c78e0488dd78130dc4eb6fe81a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a10a58c0715cac006dd4d05f1f1ad6eb2">getDynamicClassID</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID POLYMORPHICALLY. <a href="#a10a58c0715cac006dd4d05f1f1ad6eb2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a44ac6c9d28fcc101ba8cfce3e9230871">format</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, const <a class="el" href="classFormattable.html">Formattable</a> *arguments, int32_t count, <a class="el" href="classUnicodeString.html">UnicodeString</a> &appendTo, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the given array of arguments into a user-readable string using the given pattern. <a href="#a44ac6c9d28fcc101ba8cfce3e9230871"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#a1649c7540f4789dbc2fd43bb251e3dd8">autoQuoteApostrophe</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &pattern, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an 'apostrophe-friendly' pattern into a standard pattern. <a href="#a1649c7540f4789dbc2fd43bb251e3dd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMessageFormat.html#aabdeb33d4de48799fe111a337d0684c6">getStaticClassID</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the class ID for this class. <a href="#aabdeb33d4de48799fe111a337d0684c6"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a633236b616d8e67ea32f83ed52132aae"></a><!-- doxytag: member="MessageFormat::MessageFormatAdapter" ref="a633236b616d8e67ea32f83ed52132aae" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>MessageFormatAdapter</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> produces concatenated messages in a language-neutral way. </p>
<p>Use this whenever concatenating strings that are displayed to end users.</p>
<p>A <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> contains an array of <em>subformats</em> arranged within a <em>template string</em>. Together, the subformats and template string determine how the <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> will operate during formatting and parsing.</p>
<p>Typically, both the subformats and the template string are specified at once in a <em>pattern</em>. By using different patterns for different locales, messages may be localized.</p>
<p>When formatting, <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> takes an array of arguments and produces a user-readable string. Each argument is a <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object; they may be passed in in an array, or as a single <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object which itself contains an array. Each argument is matched up with its corresponding subformat, which then formats it into a string. The resulting strings are then assembled within the string template of the <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> to produce the final output string.</p>
<p><b>Note:</b> In ICU 4.0 <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> supports named arguments. If a named argument is used, all arguments must be named. Names start with a character in <code>UCHAR_ID_START</code> and continue with characters in <code>UCHARID_CONTINUE</code>, in particular they do not start with a digit. If named arguments are used, <a class="el" href="classMessageFormat.html#a40b7cb584ce76b7bc3be2289a48c9f96">usesNamedArguments()</a> will return true.</p>
<p>The other new methods supporting named arguments are <a class="el" href="classMessageFormat.html#a4767de0a57c55c404db332be67edb73e">getFormatNames(UErrorCode& status)</a>, <a class="el" href="classMessageFormat.html#aaa4cef286b4f4f5845ed783e079ad96b">getFormat(const UnicodeString& formatName, UErrorCode& status)</a> <a class="el" href="classMessageFormat.html#a781ee11f6a1512717b670b6e0db229d9">setFormat(const UnicodeString& formatName, const Format& format, UErrorCode& status)</a>, <a class="el" href="classMessageFormat.html#ab1f5fd9a8e07a97020fe8618fed368b4">adoptFormat(const UnicodeString& formatName, Format* formatToAdopt, UErrorCode& status)</a>, <a class="el" href="">UnicodeString* argumentNames, const Formattable* arguments, int32_t count, UnicodeString& appendTo,UErrorCode& status)</a>. These methods are all compatible with patterns that do not used named arguments-- in these cases the keys in the input or output use <code><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a></code>s that name the argument indices, e.g. "0", "1", "2"... etc.</p>
<p>If this format uses named arguments, certain methods that take or return arrays do not perform any action, since it is not possible to identify positions in an array using a name. Of these methods, UErrorCode is set to U_ILLEGAL_ARGUMENT_ERROR by format, and to U_ARGUMENT_TYPE_MISMATCH by parse. These methods are <a class="el" href="classMessageFormat.html#a4322393c6960d0abbecb97e2d5db7032">adoptFormats(Format** formatsToAdopt, int32_t count)</a>, <a class="el" href="classMessageFormat.html#a7d51d28b509a3d1365b250be805556a8">setFormats(const Format** newFormats,int32_t count)</a>, <a class="el" href="classMessageFormat.html#a96f9fb97e9bc525197b39222aba74bcc">adoptFormat(int32_t n, Format *newFormat)</a>, <a class="el" href="">setFormat(int32_t n, Format& newFormat)</a>, <a class="el" href="">format(const Formattable* source, int32_t count, UnicodeString& appendTo, FieldPosition& ignore, UErrorCode& success)</a>, <a class="el" href="classMessageFormat.html#a44ac6c9d28fcc101ba8cfce3e9230871">format(const UnicodeString& pattern,const Formattable* arguments,int32_t cnt,UnicodeString& appendTo,UErrorCode& success)</a>, <a class="el" href="">format(const Formattable& source, UnicodeString& appendTo, FieldPosition& ignore, UErrorCode& success)</a>, <a class="el" href="">format(const Formattable* arguments, int32_t cnt, UnicodeString& appendTo, FieldPosition& status, int32_t recursionProtection,UErrorCode& success)</a>, <a class="el" href="">parse(const UnicodeString& source, ParsePosition& pos, int32_t& count)</a>, <a class="el" href="">parse(const UnicodeString& source, int32_t& cnt, UErrorCode& status)</a></p>
<p>During parsing, an input string is matched against the string template of the <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> to produce an array of <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> objects. Plain text of the template string is matched directly against input text. At each position in the template string where a subformat is located, the subformat is called to parse the corresponding segment of input text to produce an output argument. In this way, an array of arguments is created which together constitute the parse result. </p>
<p>Parsing may fail or produce unexpected results in a number of circumstances. </p>
<ul>
<li>
If one of the arguments does not occur in the pattern, it will be returned as a default <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a>. </li>
<li>
If the format of an argument loses information, such as with a choice format where a large number formats to "many", then the parse may not correspond to the originally formatted argument. </li>
<li>
<a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> does not handle <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> recursion during parsing; such parses will fail. </li>
<li>
Parsing will not always find a match (or the correct match) if some part of the parse is ambiguous. For example, if the pattern "{1},{2}" is used with the string arguments {"a,b", "c"}, it will format as "a,b,c". When the result is parsed, it will return {"a", "b,c"}. </li>
<li>
If a single argument is formatted more than once in the string, then the rightmost subformat in the pattern string will produce the parse result; prior subformats with the same argument index will have no effect. </li>
</ul>
<p>Here are some examples of usage: </p>
<p>Example 1: </p>
<pre>
<div class="fragment"><pre class="fragment"> <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> success = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9" title="No error, no warning.">U_ZERO_ERROR</a>;
<a class="code" href="classGregorianCalendar.html" title="Concrete class which provides the standard calendar used by most of the world.">GregorianCalendar</a> cal(success);
<a class="code" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> arguments[] = {
7L,
<a class="code" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a>( (Date) cal.getTime(success), Formattable::kIsDate),
<span class="stringliteral">"a disturbance in the Force"</span>
};
<a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> result;
<a class="code" href="classMessageFormat.html#ac984e47d8f99db7f623bd60f856f8666" title="Formats the given array of arguments into a user-readable string.">MessageFormat::format</a>(
<span class="stringliteral">"At {1,time} on {1,date}, there was {2} on planet {0,number}."</span>,
arguments, 3, result, success );
cout << <span class="stringliteral">"result: "</span> << result << endl;
<span class="comment">//<output>: At 4:34:20 PM on 23-Mar-98, there was a disturbance</span>
<span class="comment">// in the Force on planet 7.</span>
</pre></div>
</pre><p> Typically, the message format will come from resources, and the arguments will be dynamically set at runtime. </p>
<p>Example 2: </p>
<pre>
<div class="fragment"><pre class="fragment"> success = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9" title="No error, no warning.">U_ZERO_ERROR</a>;
<a class="code" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> testArgs[] = {3L, <span class="stringliteral">"MyDisk"</span>};
<a class="code" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> form(
<span class="stringliteral">"The disk \"{1}\" contains {0} file(s)."</span>, success );
<a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> string;
<a class="code" href="classFieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields...">FieldPosition</a> fpos = 0;
cout << <span class="stringliteral">"format: "</span> << form.<a class="code" href="classNumberFormat.html#a53e27d424735198566d90eb30401ec36" title="Format an object to produce a string.">format</a>(testArgs, 2, <span class="keywordtype">string</span>, fpos, success ) << endl;
<span class="comment">// output, with different testArgs:</span>
<span class="comment">// output: The disk "MyDisk" contains 0 file(s).</span>
<span class="comment">// output: The disk "MyDisk" contains 1 file(s).</span>
<span class="comment">// output: The disk "MyDisk" contains 1,273 file(s).</span>
</pre></div>
</pre><p>The pattern is of the following form. Legend: </p>
<pre>
<div class="fragment"><pre class="fragment"> {optional item}
(group that may be repeated)*
</pre></div>
</pre><p> Do not confuse optional items with items inside quoted braces, such as this: "{". Quoted braces are literals. </p>
<pre>
<div class="fragment"><pre class="fragment"> messageFormatPattern := string ( <span class="stringliteral">"{"</span> messageFormatElement <span class="stringliteral">"}"</span> <span class="keywordtype">string</span> )*
messageFormatElement := argumentIndex | argumentName { <span class="stringliteral">","</span> elementFormat }
elementFormat := <span class="stringliteral">"time"</span> { <span class="stringliteral">","</span> datetimeStyle }
| <span class="stringliteral">"date"</span> { <span class="stringliteral">","</span> datetimeStyle }
| <span class="stringliteral">"number"</span> { <span class="stringliteral">","</span> numberStyle }
| <span class="stringliteral">"choice"</span> <span class="stringliteral">","</span> choiceStyle
| <span class="stringliteral">"spellout"</span> { <span class="stringliteral">","</span> spelloutStyle }
| <span class="stringliteral">"ordinal"</span> { <span class="stringliteral">","</span> spelloutStyle }
| <span class="stringliteral">"duration"</span> { <span class="stringliteral">","</span> spelloutStyle }
| <span class="stringliteral">"plural"</span> <span class="stringliteral">","</span> pluralStyle
| <span class="stringliteral">"select"</span> <span class="stringliteral">","</span> selectStyle
datetimeStyle := <span class="stringliteral">"short"</span>
| <span class="stringliteral">"medium"</span>
| <span class="stringliteral">"long"</span>
| <span class="stringliteral">"full"</span>
| dateFormatPattern
numberStyle := <span class="stringliteral">"currency"</span>
| <span class="stringliteral">"percent"</span>
| <span class="stringliteral">"integer"</span>
| numberFormatPattern
choiceStyle := choiceFormatPattern
pluralStyle := pluralFormatPattern
selectStyle := selectFormatPattern
spelloutStyle := ruleSetName
</pre></div>
</pre><p> If there is no elementFormat, then the argument must be a string, which is substituted. If there is no dateTimeStyle or numberStyle, then the default format is used (e.g. <a class="el" href="classNumberFormat.html#a2483fa1e87f3600395ff0c8f364f7b6f" title="Returns the default number format for the current default locale.">NumberFormat::createInstance()</a>, <a class="el" href="classDateFormat.html#abfd5a63e39e890a2ff07a5b15ec88a42" title="Creates a time formatter with the given formatting style for the given locale.">DateFormat::createTimeInstance</a>(DateFormat::kDefault, ...) or <a class="el" href="classDateFormat.html#a4421ca0c8b71b078f3ab9433f5413380" title="Creates a date formatter with the given formatting style for the given const locale...">DateFormat::createDateInstance</a>(DateFormat::kDefault, ...). For a <a class="el" href="classRuleBasedNumberFormat.html" title="The RuleBasedNumberFormat class formats numbers according to a set of rules.">RuleBasedNumberFormat</a>, if there is no ruleSetName, the default rule set is used. For a <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> or <a class="el" href="classPluralFormat.html">PluralFormat</a> or <a class="el" href="classSelectFormat.html">SelectFormat</a>, the pattern must always be specified, since there is no default. </p>
<p>In strings, single quotes can be used to quote syntax characters. A literal single quote is represented by '', both within and outside of single-quoted segments. Inside a messageFormatElement, quotes are <em>not</em> removed. For example, {1,number,$'#',##} will produce a number format with the pound-sign quoted, with a result such as: "$#31,45". </p>
<p>If a pattern is used, then unquoted braces in the pattern, if any, must match: that is, "ab {0} de" and "ab '}' de" are ok, but "ab
{0'}' de" and "ab } de" are not. </p>
<dl>
<dt><b>Warning:</b></dt>
<dd>The rules for using quotes within message format patterns unfortunately have shown to be somewhat confusing. In particular, it isn't always obvious to localizers whether single quotes need to be doubled or not. Make sure to inform localizers about the rules, and tell them (for example, by using comments in resource bundle source files) which strings will be processed by <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a>. Note that localizers may need to use single quotes in translated strings where the original version doesn't have them. <br/>
Note also that the simplest way to avoid the problem is to use the real apostrophe (single quote) character U+2019 (') for human-readable text, and to use the ASCII apostrophe (U+0027 ' ) only in program syntax, like quoting in <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a>. See the annotations for U+0027 Apostrophe in The Unicode Standard. </dd>
</dl>
<p>The argumentIndex is a non-negative integer, which corresponds to the index of the arguments presented in an array to be formatted. The first argument has argumentIndex 0. </p>
<p>It is acceptable to have unused arguments in the array. With missing arguments, or arguments that are not of the right class for the specified format, a failing UErrorCode result is set. </p>
<p>For more sophisticated patterns, you can use a <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> to get output: </p>
<pre>
<div class="fragment"><pre class="fragment"> <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c" title="Error code to replace exception handling, so that the code is compatible with all...">UErrorCode</a> success = <a class="code" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78caa43dbfc9499c5f911d04e1a0ca3bf6f9" title="No error, no warning.">U_ZERO_ERROR</a>;
<a class="code" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a>* form(<span class="stringliteral">"The disk \"{1}\" contains {0}."</span>, success);
<span class="keywordtype">double</span> filelimits[] = {0,1,2};
<a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> filepart[] = {<span class="stringliteral">"no files"</span>,<span class="stringliteral">"one file"</span>,<span class="stringliteral">"{0,number} files"</span>};
<a class="code" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a>* fileform = <span class="keyword">new</span> <a class="code" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a>(filelimits, filepart, 3);
form.setFormat(1, *fileform); <span class="comment">// NOT zero, see below</span>
<a class="code" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> testArgs[] = {1273L, <span class="stringliteral">"MyDisk"</span>};
<a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> string;
<a class="code" href="classFieldPosition.html" title="FieldPosition is a simple class used by Format and its subclasses to identify fields...">FieldPosition</a> fpos = 0;
cout << form.<a class="code" href="classNumberFormat.html#a53e27d424735198566d90eb30401ec36" title="Format an object to produce a string.">format</a>(testArgs, 2, <span class="keywordtype">string</span>, fpos, success) << endl;
<span class="comment">// output, with different testArgs</span>
<span class="comment">// output: The disk "MyDisk" contains no files.</span>
<span class="comment">// output: The disk "MyDisk" contains one file.</span>
<span class="comment">// output: The disk "MyDisk" contains 1,273 files.</span>
</pre></div>
</pre><p> You can either do this programmatically, as in the above example, or by using a pattern (see <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> for more information) as in: </p>
<pre>
<div class="fragment"><pre class="fragment"> form.applyPattern(
<span class="stringliteral">"There {0,choice,0#are no files|1#is one file|1<are {0,number,integer} files}."</span>);
</pre></div>
</pre> <p><em>Note:</em> As we see above, the string produced by a <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> in <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> is treated specially; occurences of '{' are used to indicated subformats, and cause recursion. If you create both a <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> and <a class="el" href="classChoiceFormat.html" title="ChoiceFormat converts between ranges of numeric values and string names for those...">ChoiceFormat</a> programmatically (instead of using the string patterns), then be careful not to produce a format that recurses on itself, which will cause an infinite loop. </p>
<p><em>Note:</em> Subformats are numbered by their order in the pattern. This is <em>not</em> the same as the argumentIndex. </p>
<pre>
<div class="fragment"><pre class="fragment"> For example: with <span class="stringliteral">"abc{2}def{3}ghi{0}..."</span>,
format0 affects the first variable {2}
format1 affects the second variable {3}
format2 affects the second variable {0}
</pre></div>
</pre><p><em>User subclasses are not supported.</em> While clients may write subclasses, such code will not necessarily work and will not be guaranteed to work stably from release to release. </p>
<p>Definition at line <a class="el" href="msgfmt_8h_source.html#l00317">317</a> of file <a class="el" href="msgfmt_8h_source.html">msgfmt.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a3b02759e9345bba433598ca169fe2626"></a><!-- doxytag: member="MessageFormat::EFormatNumber" ref="a3b02759e9345bba433598ca169fe2626" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classMessageFormat.html#a3b02759e9345bba433598ca169fe2626">MessageFormat::EFormatNumber</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enum type for kMaxFormat. </p>
<dl class="obsolete"><dt><b><a class="el" href="obsolete.html#_obsolete000002">Obsolete:</a></b></dt><dd>ICU 3.0. The 10-argument limit was removed as of ICU 2.6, rendering this enum type obsolete. </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a3b02759e9345bba433598ca169fe2626a2c4649766d55fba1106595c70fab6a79"></a><!-- doxytag: member="kMaxFormat" ref="a3b02759e9345bba433598ca169fe2626a2c4649766d55fba1106595c70fab6a79" args="" -->kMaxFormat</em> </td><td>
<p>The maximum number of arguments. </p>
<dl class="obsolete"><dt><b><a class="el" href="obsolete.html#_obsolete000003">Obsolete:</a></b></dt><dd>ICU 3.0. The 10-argument limit was removed as of ICU 2.6, rendering this constant obsolete. </dd></dl>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="msgfmt_8h_source.html#l00324">324</a> of file <a class="el" href="msgfmt_8h_source.html">msgfmt.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9bd166332a223bf4f626bd4a23826da2"></a><!-- doxytag: member="MessageFormat::MessageFormat" ref="a9bd166332a223bf4f626bd4a23826da2" args="(const UnicodeString &pattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessageFormat::MessageFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and the default locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Pattern used to construct object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002761">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a09d0a688a0017c803eb903b5956de3a0"></a><!-- doxytag: member="MessageFormat::MessageFormat" ref="a09d0a688a0017c803eb903b5956de3a0" args="(const UnicodeString &pattern, const Locale &newLocale, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessageFormat::MessageFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>newLocale</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Pattern used to construct object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>newLocale</em> </td><td>The locale to use for formatting dates and numbers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002762">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="adf000f6a8019f6e9999d3df283688843"></a><!-- doxytag: member="MessageFormat::MessageFormat" ref="adf000f6a8019f6e9999d3df283688843" args="(const UnicodeString &pattern, const Locale &newLocale, UParseError &parseError, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessageFormat::MessageFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>newLocale</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>parseError</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> using the given pattern and locale. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>Pattern used to construct object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>newLocale</em> </td><td>The locale to use for formatting dates and numbers. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseError</em> </td><td>Struct to recieve information on position of error within the pattern. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002763">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a945eac8450aca382e2db73b7c3187249"></a><!-- doxytag: member="MessageFormat::MessageFormat" ref="a945eac8450aca382e2db73b7c3187249" args="(const MessageFormat &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MessageFormat::MessageFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMessageFormat.html">MessageFormat</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> from an existing one. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002764">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a37bc94ae7e3622880f9f79d58320796b"></a><!-- doxytag: member="MessageFormat::~MessageFormat" ref="a37bc94ae7e3622880f9f79d58320796b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual MessageFormat::~MessageFormat </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002766">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab1f5fd9a8e07a97020fe8618fed368b4"></a><!-- doxytag: member="MessageFormat::adoptFormat" ref="ab1f5fd9a8e07a97020fe8618fed368b4" args="(const UnicodeString &formatName, Format *formatToAdopt, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::adoptFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>formatName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFormat.html">Format</a> * </td>
<td class="paramname"> <em>formatToAdopt</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets one subformat for given format name. </p>
<p>See the class description about format name. This function supports both named and numbered arguments-- if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). If there is no matched formatName or wrong type, the item will be ignored. The caller should not delete the <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object after this call. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatName</em> </td><td>Name of the subformat. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>formatToAdopt</em> </td><td><a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> to be adopted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002781">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a96f9fb97e9bc525197b39222aba74bcc"></a><!-- doxytag: member="MessageFormat::adoptFormat" ref="a96f9fb97e9bc525197b39222aba74bcc" args="(int32_t formatNumber, Format *formatToAdopt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::adoptFormat </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>formatNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFormat.html">Format</a> * </td>
<td class="paramname"> <em>formatToAdopt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets one subformat. </p>
<p>See the class description about format numbering. The caller should not delete the <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object after this call. If the number is over the number of formats already set, the item will be deleted and ignored.</p>
<p>If this format uses named arguments, the new format is discarded and this format remains unchanged.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002776">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatNumber</em> </td><td>index of the subformat. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>formatToAdopt</em> </td><td>the format to be adopted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a4322393c6960d0abbecb97e2d5db7032"></a><!-- doxytag: member="MessageFormat::adoptFormats" ref="a4322393c6960d0abbecb97e2d5db7032" args="(Format **formatsToAdopt, int32_t count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::adoptFormats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFormat.html">Format</a> ** </td>
<td class="paramname"> <em>formatsToAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets subformats. </p>
<p>See the class description about format numbering. The caller should not delete the <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects after this call. <em>The array formatsToAdopt is not itself adopted.</em> Its ownership is retained by the caller. If the call fails because memory cannot be allocated, then the formats will be deleted by this method, and this object will remain unchanged.</p>
<p>If this format uses named arguments, the new formats are discarded and this format remains unchanged.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002774">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatsToAdopt</em> </td><td>the format to be adopted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>the size of the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad5e44f1a945520eefade9b60350a3327"></a><!-- doxytag: member="MessageFormat::applyPattern" ref="ad5e44f1a945520eefade9b60350a3327" args="(const UnicodeString &pattern, UParseError &parseError, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::applyPattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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="structUParseError.html">UParseError</a> & </td>
<td class="paramname"> <em>parseError</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Applies the given pattern string to this message format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>The pattern to be applied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parseError</em> </td><td>Struct to recieve information on position of error within pattern. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002772">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ace3d4f8c18ba0b07aada0066efb9ab9d"></a><!-- doxytag: member="MessageFormat::applyPattern" ref="ace3d4f8c18ba0b07aada0066efb9ab9d" args="(const UnicodeString &pattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::applyPattern </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Applies the given pattern string to this message format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>The pattern to be applied. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002771">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1649c7540f4789dbc2fd43bb251e3dd8"></a><!-- doxytag: member="MessageFormat::autoQuoteApostrophe" ref="a1649c7540f4789dbc2fd43bb251e3dd8" args="(const UnicodeString &pattern, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a> MessageFormat::autoQuoteApostrophe </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert an 'apostrophe-friendly' pattern into a standard pattern. </p>
<p>Standard patterns treat all apostrophes as quotes, which is problematic in some languages, e.g. French, where apostrophe is commonly used. This utility assumes that only an unpaired apostrophe immediately before a brace is a true quote. Other unpaired apostrophes are paired, and the resulting standard pattern string is returned.</p>
<p><b>Note</b> it is not guaranteed that the returned pattern is indeed a valid pattern. The only effect is to convert between patterns having different quoting semantics.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>the 'apostrophe-friendly' patttern to convert </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, the failure code is set. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the standard equivalent of the original pattern </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002791">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="abe6a3b6d9e7e74b7586b4644e4ba001c"></a><!-- doxytag: member="MessageFormat::clone" ref="abe6a3b6d9e7e74b7586b4644e4ba001c" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormat.html">Format</a>* MessageFormat::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clones this <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object polymorphically. </p>
<p>The caller owns the result and should delete it when done. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002767">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#a4e7ebd5cfd390c35e2bda88257f8b51a">Format</a>.</p>
</div>
</div>
<a class="anchor" id="a8fd632cd6603981f64301fca9bb15eec"></a><!-- doxytag: member="MessageFormat::format" ref="a8fd632cd6603981f64301fca9bb15eec" args="(const UnicodeString *argumentNames, const Formattable *arguments, int32_t count, UnicodeString &appendTo, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& MessageFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> * </td>
<td class="paramname"> <em>argumentNames</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> * </td>
<td class="paramname"> <em>arguments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats the given array of arguments into a user-defined argument name array. </p>
<p>This function supports both named and numbered arguments-- if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>argumentNames</em> </td><td>argument name array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>An array of objects to be formatted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of elements of 'argumentNames' and arguments. The number of argumentNames and arguments must be the same. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002787">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7e78ae8192e0889a196b0b4ae86a3a6a"></a><!-- doxytag: member="MessageFormat::format" ref="a7e78ae8192e0889a196b0b4ae86a3a6a" args="(const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> & MessageFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats the given array of arguments into a user-readable string. </p>
<p>The array must be stored within a single <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object of type kArray. If the <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object type is not of type kArray, then returns a failing UErrorCode.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>The object to format </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002786">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classFormat.html#af3f0b157f07d6e9f908da69c99239600">Format</a>.</p>
<p>Definition at line <a class="el" href="msgfmt_8h_source.html#l00976">976</a> of file <a class="el" href="msgfmt_8h_source.html">msgfmt.h</a>.</p>
<p>References <a class="el" href="classMessageFormat.html#ac984e47d8f99db7f623bd60f856f8666">format()</a>.</p>
</div>
</div>
<a class="anchor" id="a427aef9177f57f8c1fd37c3a3d157437"></a><!-- doxytag: member="MessageFormat::format" ref="a427aef9177f57f8c1fd37c3a3d157437" args="(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a>& MessageFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>obj</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.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="classFieldPosition.html">FieldPosition</a> & </td>
<td class="paramname"> <em>pos</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats the given array of arguments into a user-readable string. </p>
<p>The array must be stored within a single <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object of type kArray. If the <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> object type is not of type kArray, then returns a failing UErrorCode.</p>
<p>If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em> </td><td>A <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> of type kArray containing arguments to be formatted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>On input: an alignment field, if desired. On output: the offsets of the alignment field. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002785">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#a12ffb857c5c9a553270dfe9a71fbd8e9">Format</a>.</p>
</div>
</div>
<a class="anchor" id="a44ac6c9d28fcc101ba8cfce3e9230871"></a><!-- doxytag: member="MessageFormat::format" ref="a44ac6c9d28fcc101ba8cfce3e9230871" args="(const UnicodeString &pattern, const Formattable *arguments, int32_t count, UnicodeString &appendTo, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a>& MessageFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> * </td>
<td class="paramname"> <em>arguments</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats the given array of arguments into a user-readable string using the given pattern. </p>
<p>If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pattern</em> </td><td>The pattern. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>arguments</em> </td><td>An array of objects to be formatted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of elements of 'source'. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002784">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac984e47d8f99db7f623bd60f856f8666"></a><!-- doxytag: member="MessageFormat::format" ref="ac984e47d8f99db7f623bd60f856f8666" args="(const Formattable *source, int32_t count, UnicodeString &appendTo, FieldPosition &ignore, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a>& MessageFormat::format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormattable.html">Formattable</a> * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classUnicodeString.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="classFieldPosition.html">FieldPosition</a> & </td>
<td class="paramname"> <em>ignore</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Formats the given array of arguments into a user-readable string. </p>
<p>Does not take ownership of the Formattable* array or its contents.</p>
<p>If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>An array of objects to be formatted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>The number of elements of 'source'. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive result. Result is appended to existing contents. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ignore</em> </td><td>Not used; inherited from base class API. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002783">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Referenced by <a class="el" href="msgfmt_8h_source.html#l00976">format()</a>.</p>
</div>
</div>
<a class="anchor" id="a6e9db2c78e0488dd78130dc4eb6fe81a"></a><!-- doxytag: member="MessageFormat::getArgTypeCount" ref="a6e9db2c78e0488dd78130dc4eb6fe81a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t MessageFormat::getArgTypeCount </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This API is for ICU internal use only. </p>
<p>Please do not use it.</p>
<p>Returns argument types count in the parsed pattern. Used to distinguish pattern "{0} d" and "d".</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of formattable types in the pattern </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000320">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a10a58c0715cac006dd4d05f1f1ad6eb2"></a><!-- doxytag: member="MessageFormat::getDynamicClassID" ref="a10a58c0715cac006dd4d05f1f1ad6eb2" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> MessageFormat::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a unique class ID POLYMORPHICALLY. </p>
<p>Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="classMessageFormat.html#a26e0c92e8035193f110b578381611c02" title="Returns true if the given Format objects are semantically equal.">operator==()</a> and <a class="el" href="classMessageFormat.html#abe6a3b6d9e7e74b7586b4644e4ba001c" title="Clones this Format object polymorphically.">clone()</a> methods call this method.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002793">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#ac961d410d174518e5a3ebb8bbef45cd7">Format</a>.</p>
</div>
</div>
<a class="anchor" id="aaa4cef286b4f4f5845ed783e079ad96b"></a><!-- doxytag: member="MessageFormat::getFormat" ref="aaa4cef286b4f4f5845ed783e079ad96b" args="(const UnicodeString &formatName, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormat.html">Format</a>* MessageFormat::getFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>formatName</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets subformat pointer for given format name. </p>
<p>This function supports both named and numbered arguments-- if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). The returned <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> object should not be deleted by the caller, nor should the ponter of other object . The pointer and its contents remain valid only until the next call to any method of this class is made with this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatName</em> </td><td>the name or number specifying a format </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002779">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a4767de0a57c55c404db332be67edb73e"></a><!-- doxytag: member="MessageFormat::getFormatNames" ref="a4767de0a57c55c404db332be67edb73e" args="(UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* MessageFormat::getFormatNames </td>
<td>(</td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets format names. </p>
<p>This function returns formatNames in StringEnumerations which can be used with <a class="el" href="classMessageFormat.html#aaa4cef286b4f4f5845ed783e079ad96b" title="Gets subformat pointer for given format name.">getFormat()</a> and <a class="el" href="classMessageFormat.html#a16530e29c89c9a569d973b0e5f0fc598" title="Sets one subformat.">setFormat()</a> to export formattable array from current <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> to another. It is caller's resposibility to delete the returned formatNames. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002778">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ae6fab4bde713f7c17f12c8a6dc9ce89b"></a><!-- doxytag: member="MessageFormat::getFormats" ref="ae6fab4bde713f7c17f12c8a6dc9ce89b" args="(int32_t &count) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classFormat.html">Format</a>** MessageFormat::getFormats </td>
<td>(</td>
<td class="paramtype">int32_t & </td>
<td class="paramname"> <em>count</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets an array of subformats of this object. </p>
<p>The returned array should not be deleted by the caller, nor should the pointers within the array. The array and its contents remain valid only until the next call to this format. See the class description about format numbering.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>output parameter to receive the size of the array </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of count Format* objects, or NULL if out of memory. Any or all of the array elements may be NULL. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002782">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a422910b60d0e79cf37afa8a49418333b"></a><!-- doxytag: member="MessageFormat::getLocale" ref="a422910b60d0e79cf37afa8a49418333b" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classLocale.html">Locale</a>& MessageFormat::getLocale </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the locale. </p>
<p>This locale is used for fetching default number or date format information. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the locale of the object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002770">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="aabdeb33d4de48799fe111a337d0684c6"></a><!-- doxytag: member="MessageFormat::getStaticClassID" ref="aabdeb33d4de48799fe111a337d0684c6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> MessageFormat::getStaticClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the class ID for this class. </p>
<p>This is useful only for comparing to a return value from <a class="el" href="classMessageFormat.html#a10a58c0715cac006dd4d05f1f1ad6eb2" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a>. For example: </p>
<pre>
. Base* polymorphic_pointer = createPolymorphicObject();
. if (polymorphic_pointer-><a class="el" href="classMessageFormat.html#a10a58c0715cac006dd4d05f1f1ad6eb2" title="Returns a unique class ID POLYMORPHICALLY.">getDynamicClassID()</a> ==
. Derived::getStaticClassID()) ...
</pre> <dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for all objects of this class. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002794">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a48e4814289b48723b11e7cd00df0be69"></a><!-- doxytag: member="MessageFormat::operator=" ref="a48e4814289b48723b11e7cd00df0be69" args="(const MessageFormat &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMessageFormat.html">MessageFormat</a>& MessageFormat::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMessageFormat.html">MessageFormat</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002765">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classFormat.html#a7a5276a88c488462eea3a508b71f4d9c">Format</a>.</p>
</div>
</div>
<a class="anchor" id="a26e0c92e8035193f110b578381611c02"></a><!-- doxytag: member="MessageFormat::operator==" ref="a26e0c92e8035193f110b578381611c02" args="(const Format &other) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> MessageFormat::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are semantically equal. </p>
<p>Objects of different subclasses are considered unequal. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>the object to be compared with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the given <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> objects are semantically equal. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002768">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac4eeb461355c2d0f7c5a76c1d640eefd"></a><!-- doxytag: member="MessageFormat::parse" ref="ac4eeb461355c2d0f7c5a76c1d640eefd" args="(const UnicodeString &source, int32_t &count, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormattable.html">Formattable</a>* MessageFormat::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t & </td>
<td class="paramname"> <em>count</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the given string into an array of output arguments. </p>
<p>If this format uses named arguments, status is set to U_ARGUMENT_TYPE_MISMATCH.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>String to be parsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>Output param to receive size of returned array. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>Input/output error code. If the pattern cannot be parsed, set to failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of parsed arguments. The caller owns both the array and its contents. Returns NULL if status is not U_ZERO_ERROR.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002789">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ad9f1ebf28e194700db6fef7c16009ea5"></a><!-- doxytag: member="MessageFormat::parse" ref="ad9f1ebf28e194700db6fef7c16009ea5" args="(const UnicodeString &source, ParsePosition &pos, int32_t &count) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classFormattable.html">Formattable</a>* MessageFormat::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classParsePosition.html">ParsePosition</a> & </td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t & </td>
<td class="paramname"> <em>count</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the given string into an array of output arguments. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>String to be parsed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>On input, starting position for parse. On output, final position after parse. Unchanged if parse fails. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>Output parameter to receive the number of arguments parsed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>an array of parsed arguments. The caller owns both the array and its contents. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002788">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a53732066584f68579adf8bf91409217c"></a><!-- doxytag: member="MessageFormat::parseObject" ref="a53732066584f68579adf8bf91409217c" args="(const UnicodeString &source, Formattable &result, ParsePosition &pos) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::parseObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classFormattable.html">Formattable</a> & </td>
<td class="paramname"> <em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classParsePosition.html">ParsePosition</a> & </td>
<td class="paramname"> <em>pos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parses the given string into an array of output arguments stored within a single <a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> of type kArray. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>The string to be parsed into an object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td><a class="el" href="classFormattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting...">Formattable</a> to be set to the parse result. If parse fails, return contents are undefined. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>On input, starting position for parse. On output, final position after parse. Unchanged if parse fails. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002790">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classFormat.html#aa53bea97b986c2f21e5638aa30aa08b7">Format</a>.</p>
</div>
</div>
<a class="anchor" id="a781ee11f6a1512717b670b6e0db229d9"></a><!-- doxytag: member="MessageFormat::setFormat" ref="a781ee11f6a1512717b670b6e0db229d9" args="(const UnicodeString &formatName, const Format &format, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::setFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>formatName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> <em>format</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>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets one subformat for given format name. </p>
<p>See the class description about format name. This function supports both named and numbered arguments-- if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). If there is no matched formatName or wrong type, the item will be ignored. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatName</em> </td><td>Name of the subformat. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>the format to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>output param set to success/failure code. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002780">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a16530e29c89c9a569d973b0e5f0fc598"></a><!-- doxytag: member="MessageFormat::setFormat" ref="a16530e29c89c9a569d973b0e5f0fc598" args="(int32_t formatNumber, const Format &format)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::setFormat </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>formatNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> & </td>
<td class="paramname"> <em>format</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets one subformat. </p>
<p>See the class description about format numbering. If the number is over the number of formats already set, the item will be ignored. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatNumber</em> </td><td>index of the subformat. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>the format to be set. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002777">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a7d51d28b509a3d1365b250be805556a8"></a><!-- doxytag: member="MessageFormat::setFormats" ref="a7d51d28b509a3d1365b250be805556a8" args="(const Format **newFormats, int32_t cnt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::setFormats </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFormat.html">Format</a> ** </td>
<td class="paramname"> <em>newFormats</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>cnt</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets subformats. </p>
<p>See the class description about format numbering. Each item in the array is cloned into the internal array. If the call fails because memory cannot be allocated, then this object will remain unchanged.</p>
<p>If this format uses named arguments, the new formats are discarded and this format remains unchanged.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002775">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newFormats</em> </td><td>the new format to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cnt</em> </td><td>the size of the array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5d403deba6c059ebd752d964ad49a7c1"></a><!-- doxytag: member="MessageFormat::setLocale" ref="a5d403deba6c059ebd752d964ad49a7c1" args="(const Locale &theLocale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MessageFormat::setLocale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.html">Locale</a> & </td>
<td class="paramname"> <em>theLocale</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the locale. </p>
<p>This locale is used for fetching default number or date format information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theLocale</em> </td><td>the new locale value to be set. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002769">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a96ffcd9c8df9b1a4b9bf604faa51eef2"></a><!-- doxytag: member="MessageFormat::toPattern" ref="a96ffcd9c8df9b1a4b9bf604faa51eef2" args="(UnicodeString &appendTo) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classUnicodeString.html">UnicodeString</a>& MessageFormat::toPattern </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>appendTo</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pattern that can be used to recreate this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>appendTo</em> </td><td>Output parameter to receive the pattern. Result is appended to existing contents. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002773">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a40b7cb584ce76b7bc3be2289a48c9f96"></a><!-- doxytag: member="MessageFormat::usesNamedArguments" ref="a40b7cb584ce76b7bc3be2289a48c9f96" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> MessageFormat::usesNamedArguments </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this <a class="el" href="classMessageFormat.html" title="MessageFormat produces concatenated messages in a language-neutral way.">MessageFormat</a> uses named arguments, and false otherwise. </p>
<p>See class description.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if named arguments are used. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable002792">Stable:</a></b></dt><dd>ICU 4.0 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="msgfmt_8h_source.html">msgfmt.h</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
136
