<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ICU 58.2: uformattable.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 58.2
 <span id="projectnumber">58.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_3c42bef9a3e7804b3d74ebb2809ebf86.html">i18n</a></li><li class="navelem"><a class="el" href="dir_fa4147b4d9cbc9ae7619e21b25239322.html">unicode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">uformattable.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: UFormattable is a thin wrapper for primitive types used for formatting and parsing.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br />
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br />
</div>
<p><a href="uformattable_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft"> </td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5a581c202607590e95f948f8273d6bc6"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a5a581c202607590e95f948f8273d6bc6">UFormattableType</a></td></tr>
<tr class="memdesc:a5a581c202607590e95f948f8273d6bc6"><td class="mdescLeft"> </td><td class="mdescRight">Enum designating the type of a UFormattable instance. <a href="#a5a581c202607590e95f948f8273d6bc6">More...</a><br /></td></tr>
<tr class="separator:a5a581c202607590e95f948f8273d6bc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d2d5a940197ec966f492f8276ee76d9"><td class="memItemLeft" align="right" valign="top">typedef void * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a></td></tr>
<tr class="memdesc:a9d2d5a940197ec966f492f8276ee76d9"><td class="mdescLeft"> </td><td class="mdescRight">Opaque type representing various types of data which may be used for formatting and parsing operations. <a href="#a9d2d5a940197ec966f492f8276ee76d9">More...</a><br /></td></tr>
<tr class="separator:a9d2d5a940197ec966f492f8276ee76d9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a5ca1403e425b22398d314ed8050eeb31"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a> { <br />
  <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31acbe9b3a6fb16bddef4268ca442603124">UFMT_DATE</a> = 0,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31a8f43ec16b9d12dc49d18b70685bf896a">UFMT_DOUBLE</a>,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31a395a7b29bce8877c8095e65f899d6499">UFMT_LONG</a>,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31a244257922a15dd5b2e2a2140e2e4668d">UFMT_STRING</a>,
<br />
  <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31a3da41174337a1a7d41d42de281db21cb">UFMT_ARRAY</a>,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31aeccbb155a4ba35697ccff1465eeaa09a">UFMT_INT64</a>,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31a5bb91a7a04d185b66faa64f90ae15214">UFMT_OBJECT</a>,
<a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31ad786652833bd88ded4cd1e24751fd778">UFMT_COUNT</a>
<br />
}<tr class="memdesc:a5ca1403e425b22398d314ed8050eeb31"><td class="mdescLeft"> </td><td class="mdescRight">Enum designating the type of a UFormattable instance. <a href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a5ca1403e425b22398d314ed8050eeb31"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aaabc4b1c0050d4e39de2994b8d9f7ef7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#aaabc4b1c0050d4e39de2994b8d9f7ef7">ufmt_open</a> (<a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aaabc4b1c0050d4e39de2994b8d9f7ef7"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a UFormattable, to type UNUM_LONG, value 0 may return error if memory allocation failed. <a href="#aaabc4b1c0050d4e39de2994b8d9f7ef7">More...</a><br /></td></tr>
<tr class="separator:aaabc4b1c0050d4e39de2994b8d9f7ef7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbfc754de3bfb920d8d857d4ce19ada8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#adbfc754de3bfb920d8d857d4ce19ada8">ufmt_close</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt)</td></tr>
<tr class="memdesc:adbfc754de3bfb920d8d857d4ce19ada8"><td class="mdescLeft"> </td><td class="mdescRight">Cleanup any additional memory allocated by this UFormattable. <a href="#adbfc754de3bfb920d8d857d4ce19ada8">More...</a><br /></td></tr>
<tr class="separator:adbfc754de3bfb920d8d857d4ce19ada8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a176f05a1d148ce3c8a42738494be4afa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a176f05a1d148ce3c8a42738494be4afa">ufmt_getType</a> (const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a176f05a1d148ce3c8a42738494be4afa"><td class="mdescLeft"> </td><td class="mdescRight">Return the type of this object. <a href="#a176f05a1d148ce3c8a42738494be4afa">More...</a><br /></td></tr>
<tr class="separator:a176f05a1d148ce3c8a42738494be4afa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10b1384e2401bf302e9500ee9934ea1a"><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="uformattable_8h.html#a10b1384e2401bf302e9500ee9934ea1a">ufmt_isNumeric</a> (const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt)</td></tr>
<tr class="memdesc:a10b1384e2401bf302e9500ee9934ea1a"><td class="mdescLeft"> </td><td class="mdescRight">Return whether the object is numeric. <a href="#a10b1384e2401bf302e9500ee9934ea1a">More...</a><br /></td></tr>
<tr class="separator:a10b1384e2401bf302e9500ee9934ea1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec0d699a30b052ea5fb05b65549d80bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#aec0d699a30b052ea5fb05b65549d80bf">ufmt_getDate</a> (const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aec0d699a30b052ea5fb05b65549d80bf"><td class="mdescLeft"> </td><td class="mdescRight">Gets the UDate value of this object. <a href="#aec0d699a30b052ea5fb05b65549d80bf">More...</a><br /></td></tr>
<tr class="separator:aec0d699a30b052ea5fb05b65549d80bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a79f4f814b591ce898eb137d512ce9e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a0a79f4f814b591ce898eb137d512ce9e">ufmt_getDouble</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a0a79f4f814b591ce898eb137d512ce9e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the double value of this object. <a href="#a0a79f4f814b591ce898eb137d512ce9e">More...</a><br /></td></tr>
<tr class="separator:a0a79f4f814b591ce898eb137d512ce9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea9891a7a493594b1334e1cdcc1e8049"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#aea9891a7a493594b1334e1cdcc1e8049">ufmt_getLong</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aea9891a7a493594b1334e1cdcc1e8049"><td class="mdescLeft"> </td><td class="mdescRight">Gets the long (int32_t) value of this object. <a href="#aea9891a7a493594b1334e1cdcc1e8049">More...</a><br /></td></tr>
<tr class="separator:aea9891a7a493594b1334e1cdcc1e8049"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa88b49ac1905631f22abc188b98e5114"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#aa88b49ac1905631f22abc188b98e5114">ufmt_getInt64</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa88b49ac1905631f22abc188b98e5114"><td class="mdescLeft"> </td><td class="mdescRight">Gets the int64_t value of this object. <a href="#aa88b49ac1905631f22abc188b98e5114">More...</a><br /></td></tr>
<tr class="separator:aa88b49ac1905631f22abc188b98e5114"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9387d3c6cc4ecb9447d773a1d86bab1"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#ab9387d3c6cc4ecb9447d773a1d86bab1">ufmt_getObject</a> (const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ab9387d3c6cc4ecb9447d773a1d86bab1"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the UObject contained within this formattable (as a const void*), or NULL if this object is not of type UFMT_OBJECT. <a href="#ab9387d3c6cc4ecb9447d773a1d86bab1">More...</a><br /></td></tr>
<tr class="separator:ab9387d3c6cc4ecb9447d773a1d86bab1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a237ad230e233dc768a1e12e792bc60af"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a237ad230e233dc768a1e12e792bc60af">ufmt_getUChars</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a237ad230e233dc768a1e12e792bc60af"><td class="mdescLeft"> </td><td class="mdescRight">Gets the string value of this object as a UChar string. <a href="#a237ad230e233dc768a1e12e792bc60af">More...</a><br /></td></tr>
<tr class="separator:a237ad230e233dc768a1e12e792bc60af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8c15408e111255e86d0a1cf4335734c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#aa8c15408e111255e86d0a1cf4335734c">ufmt_getArrayLength</a> (const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa8c15408e111255e86d0a1cf4335734c"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of array objects contained, if an array type UFMT_ARRAY. <a href="#aa8c15408e111255e86d0a1cf4335734c">More...</a><br /></td></tr>
<tr class="separator:aa8c15408e111255e86d0a1cf4335734c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e209656b712b892ed8810e5c15051cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#a6e209656b712b892ed8810e5c15051cd">ufmt_getArrayItemByIndex</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, int32_t n, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a6e209656b712b892ed8810e5c15051cd"><td class="mdescLeft"> </td><td class="mdescRight">Get the specified value from the array of UFormattables. <a href="#a6e209656b712b892ed8810e5c15051cd">More...</a><br /></td></tr>
<tr class="separator:a6e209656b712b892ed8810e5c15051cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3dfbe07f52ed41dfd50a46b08ef682b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="uformattable_8h.html#ac3dfbe07f52ed41dfd50a46b08ef682b">ufmt_getDecNumChars</a> (<a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> *fmt, int32_t *len, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:ac3dfbe07f52ed41dfd50a46b08ef682b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a numeric string representation of the number contained within this formattable, or NULL if this object does not contain numeric type. <a href="#ac3dfbe07f52ed41dfd50a46b08ef682b">More...</a><br /></td></tr>
<tr class="separator:ac3dfbe07f52ed41dfd50a46b08ef682b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C API: UFormattable is a thin wrapper for primitive types used for formatting and parsing. </p>
<p>This is a C interface to the <a class="el" href="classicu_1_1Formattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting. ">icu::Formattable</a> class. Static functions on this class convert to and from this interface (via reinterpret_cast). Note that Formattables (and thus UFormattables) are mutable, and many operations (even getters) may actually modify the internal state. For this reason, UFormattables are not thread safe, and should not be shared between threads.</p>
<p>See <a class="el" href="unum_8h.html#a26e9b033048d9562f1b09dbe1c8c4833">unum_parseToUFormattable</a> for example code. </p>
<p>Definition in file <a class="el" href="uformattable_8h_source.html">uformattable.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a9d2d5a940197ec966f492f8276ee76d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque type representing various types of data which may be used for formatting and parsing operations. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html" title="Formattable objects can be passed to the Format class or its subclasses for formatting. ">icu::Formattable</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005205">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<p>Definition at line <a class="el" href="uformattable_8h_source.html#l00070">70</a> of file <a class="el" href="uformattable_8h_source.html">uformattable.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5a581c202607590e95f948f8273d6bc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a> <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum designating the type of a UFormattable instance. </p>
<p>Practically, this indicates which of the getters would return without conversion or error. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a74d75e74861f3e85b76349f294317166" title="Selector for flavor of data type contained within a Formattable object. ">icu::Formattable::Type</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005204">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enum designating the type of a UFormattable instance. </p>
<p>Practically, this indicates which of the getters would return without conversion or error. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a74d75e74861f3e85b76349f294317166" title="Selector for flavor of data type contained within a Formattable object. ">icu::Formattable::Type</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005204">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31acbe9b3a6fb16bddef4268ca442603124"></a>UFMT_DATE </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#aec0d699a30b052ea5fb05b65549d80bf" title="Gets the UDate value of this object. ">ufmt_getDate()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#aec0d699a30b052ea5fb05b65549d80bf" title="Gets the UDate value of this object. ">ufmt_getDate</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31a8f43ec16b9d12dc49d18b70685bf896a"></a>UFMT_DOUBLE </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#a0a79f4f814b591ce898eb137d512ce9e" title="Gets the double value of this object. ">ufmt_getDouble()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a0a79f4f814b591ce898eb137d512ce9e" title="Gets the double value of this object. ">ufmt_getDouble</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31a395a7b29bce8877c8095e65f899d6499"></a>UFMT_LONG </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#aea9891a7a493594b1334e1cdcc1e8049" title="Gets the long (int32_t) value of this object. ">ufmt_getLong()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#aea9891a7a493594b1334e1cdcc1e8049" title="Gets the long (int32_t) value of this object. ">ufmt_getLong</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31a244257922a15dd5b2e2a2140e2e4668d"></a>UFMT_STRING </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#a237ad230e233dc768a1e12e792bc60af" title="Gets the string value of this object as a UChar string. ">ufmt_getUChars()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a237ad230e233dc768a1e12e792bc60af" title="Gets the string value of this object as a UChar string. ">ufmt_getUChars</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31a3da41174337a1a7d41d42de281db21cb"></a>UFMT_ARRAY </td><td class="fielddoc">
<p>ufmt_countArray() and ufmt_getArray() will return the value. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a6e209656b712b892ed8810e5c15051cd" title="Get the specified value from the array of UFormattables. ">ufmt_getArrayItemByIndex</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31aeccbb155a4ba35697ccff1465eeaa09a"></a>UFMT_INT64 </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#aa88b49ac1905631f22abc188b98e5114" title="Gets the int64_t value of this object. ">ufmt_getInt64()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#aa88b49ac1905631f22abc188b98e5114" title="Gets the int64_t value of this object. ">ufmt_getInt64</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31a5bb91a7a04d185b66faa64f90ae15214"></a>UFMT_OBJECT </td><td class="fielddoc">
<p><a class="el" href="uformattable_8h.html#ab9387d3c6cc4ecb9447d773a1d86bab1" title="Returns a pointer to the UObject contained within this formattable (as a const void*), or NULL if this object is not of type UFMT_OBJECT. ">ufmt_getObject()</a> will return without conversion. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#ab9387d3c6cc4ecb9447d773a1d86bab1" title="Returns a pointer to the UObject contained within this formattable (as a const void*), or NULL if this object is not of type UFMT_OBJECT. ">ufmt_getObject</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a5ca1403e425b22398d314ed8050eeb31ad786652833bd88ded4cd1e24751fd778"></a>UFMT_COUNT </td><td class="fielddoc">
<p>One more than the highest normal UFormattableType value. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000419">Deprecated:</a></b></dt><dd>ICU 58 The numeric value may change over time, see ICU ticket #12420. </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="uformattable_8h_source.html#l00046">46</a> of file <a class="el" href="uformattable_8h_source.html">uformattable.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adbfc754de3bfb920d8d857d4ce19ada8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ufmt_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleanup any additional memory allocated by this UFormattable. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the formatter </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005207">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#aaabc4b1c0050d4e39de2994b8d9f7ef7" title="Initialize a UFormattable, to type UNUM_LONG, value 0 may return error if memory allocation failed...">ufmt_open</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6e209656b712b892ed8810e5c15051cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a>* ufmt_getArrayItemByIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>n</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the specified value from the array of UFormattables. </p>
<p>Invalid if the object is not an array type UFMT_ARRAY </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">n</td><td>the number of the array to return (0 based). </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors. Returns an error if n is out of bounds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the nth array value, only valid while the containing UFormattable is valid. NULL if not an array. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005217">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a677c54d5468f1009595376166e669909" title="Gets the array value and count of this object. ">icu::Formattable::getArray(int32_t&, UErrorCode&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa8c15408e111255e86d0a1cf4335734c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ufmt_getArrayLength </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of array objects contained, if an array type UFMT_ARRAY. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors. U_ILLEGAL_ARGUMENT_ERROR if not an array type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of array objects or undefined if not an array type </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005216">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a6e209656b712b892ed8810e5c15051cd" title="Get the specified value from the array of UFormattables. ">ufmt_getArrayItemByIndex</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aec0d699a30b052ea5fb05b65549d80bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> ufmt_getDate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the UDate value of this object. </p>
<p>If the type is not of type UFMT_DATE, status is set to U_INVALID_FORMAT_ERROR and the return value is undefined. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005210">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a9d4a2ecdc59c66d458739be7066c52fd" title="Gets the Date value of this object. ">icu::Formattable::getDate(UErrorCode&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac3dfbe07f52ed41dfd50a46b08ef682b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ufmt_getDecNumChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>len</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a numeric string representation of the number contained within this formattable, or NULL if this object does not contain numeric type. </p>
<p>For values obtained by parsing, the returned decimal number retains the full precision and range of the original input, unconstrained by the limits of a double floating point or a 64 bit int.</p>
<p>This function is not thread safe, and therfore is not declared const, even though it is logically const. The resulting buffer is owned by the UFormattable and is invalid if any other functions are called on the UFormattable.</p>
<p>Possible errors include U_MEMORY_ALLOCATION_ERROR, and U_INVALID_STATE if the formattable object has not been set to a numeric type. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">len</td><td>if non-null, on exit contains the string length (not including the terminating null) </td></tr>
<tr><td class="paramname">status</td><td>the error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the character buffer as a NULL terminated string, which is owned by the object and must not be accessed if any other functions are called on this object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005218">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#ad12a8ee43c73877fdf6670dca32ba8e6" title="Returns a numeric string representation of the number contained within this formattable, or NULL if this object does not contain numeric type. ">icu::Formattable::getDecimalNumber(UErrorCode&)</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0a79f4f814b591ce898eb137d512ce9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double ufmt_getDouble </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the double value of this object. </p>
<p>If the type is not a UFMT_DOUBLE, or if there are additional significant digits than fit in a double type, a conversion is performed with possible loss of precision. If the type is UFMT_OBJECT and the object is a Measure, then the result of getNumber().getDouble(status) is returned. If this object is neither a numeric type nor a Measure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005211">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#ad6265f1cfe3ac798f4ba2f6e001b5ba3" title="Gets the double value of this object. ">icu::Formattable::getDouble(UErrorCode&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa88b49ac1905631f22abc188b98e5114"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t ufmt_getInt64 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the int64_t value of this object. </p>
<p>If this object is of a numeric type and the magnitude is too large to fit in an int64, then the maximum or minimum int64 value, as appropriate, is returned and the status is set to U_INVALID_FORMAT_ERROR. If the magnitude fits in an int64, then a casting conversion is peformed, with truncation of any fractional part. If the type is UFMT_OBJECT and the object is a Measure, then the result of getNumber().getDouble(status) is returned. If this object is neither a numeric type nor a Measure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005213">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#ad0dba558aafea57dd7122d45090a67e9" title="Gets the int64 value of this object. ">icu::Formattable::getInt64(UErrorCode&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aea9891a7a493594b1334e1cdcc1e8049"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t ufmt_getLong </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the long (int32_t) value of this object. </p>
<p>If the magnitude is too large to fit in a long, then the maximum or minimum long value, as appropriate, is returned and the status is set to U_INVALID_FORMAT_ERROR. If this object is of type UFMT_INT64 and it fits within a long, then no precision is lost. If it is of type kDouble or kDecimalNumber, then a conversion is peformed, with truncation of any fractional part. If the type is UFMT_OBJECT and the object is a Measure, then the result of getNumber().getLong(status) is returned. If this object is neither a numeric type nor a Measure, then 0 is returned and the status is set to U_INVALID_FORMAT_ERROR. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005212">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a613e2eb260c9a6807be07c7854552026" title="Gets the long value of this object. ">icu::Formattable::getLong(UErrorCode&) const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab9387d3c6cc4ecb9447d773a1d86bab1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const void* ufmt_getObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to the UObject contained within this formattable (as a const void*), or NULL if this object is not of type UFMT_OBJECT. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value as a const void*. It is a polymorphic C++ object. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005214">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a27313dda68b6e0b6b7f5c4a6b1e3db9f" title="Returns a pointer to the UObject contained within this formattable, or NULL if this object does not c...">icu::Formattable::getObject() const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a176f05a1d148ce3c8a42738494be4afa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uformattable_8h.html#a5ca1403e425b22398d314ed8050eeb31">UFormattableType</a> ufmt_getType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the type of this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>status code - U_ILLEGAL_ARGUMENT_ERROR is returned if the UFormattable contains data not supported by the API </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the value as a UFormattableType </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a10b1384e2401bf302e9500ee9934ea1a" title="Return whether the object is numeric. ">ufmt_isNumeric</a> </dd>
<dd>
<a class="el" href="classicu_1_1Formattable.html#a9a3d4a867918e2c4ea2bd42790ad1c37" title="Gets the data type of this Formattable object. ">icu::Formattable::getType() const</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005208">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
</div>
</div>
<a class="anchor" id="a237ad230e233dc768a1e12e792bc60af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* ufmt_getUChars </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>len</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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the string value of this object as a UChar string. </p>
<p>If the type is not a string, status is set to U_INVALID_FORMAT_ERROR and a NULL pointer is returned. This function is not thread safe and may modify the UFormattable if need be to terminate the string. The returned pointer is not valid if any other functions are called on this UFormattable, or if the UFormattable is closed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
<tr><td class="paramname">status</td><td>the error code - any conversion or format errors </td></tr>
<tr><td class="paramname">len</td><td>if non null, contains the string length on return </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the null terminated string value - must not be referenced after any other functions are called on this UFormattable. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005215">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1Formattable.html#a777836c48affedf8282d25056b7a8b7f" title="Gets the string value of this object. ">icu::Formattable::getString(UnicodeString&)const</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a10b1384e2401bf302e9500ee9934ea1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ufmt_isNumeric </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a> * </td>
<td class="paramname"><em>fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return whether the object is numeric. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>the UFormattable object </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the object is a double, long, or int64 value, else false. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#a176f05a1d148ce3c8a42738494be4afa" title="Return the type of this object. ">ufmt_getType</a> </dd>
<dd>
<a class="el" href="classicu_1_1Formattable.html#ab51d94e7fa9b1b923f733f4803e34d50" title="Returns TRUE if the data type of this Formattable object is kDouble, kLong, or kInt64. ">icu::Formattable::isNumeric() const</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005209">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
</div>
</div>
<a class="anchor" id="aaabc4b1c0050d4e39de2994b8d9f7ef7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="uformattable_8h.html#a9d2d5a940197ec966f492f8276ee76d9">UFormattable</a>* ufmt_open </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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a UFormattable, to type UNUM_LONG, value 0 may return error if memory allocation failed. </p>
<p>parameter status error code. See <a class="el" href="unum_8h.html#a26e9b033048d9562f1b09dbe1c8c4833">unum_parseToUFormattable</a> for example code. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable005206">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>the new UFormattable </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="uformattable_8h.html#adbfc754de3bfb920d8d857d4ce19ada8" title="Cleanup any additional memory allocated by this UFormattable. ">ufmt_close</a> </dd>
<dd>
<a class="el" href="classicu_1_1Formattable.html#a61e9b62f0234fff0033b093bb9b8cc2f" title="Default constructor. ">icu::Formattable::Formattable()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
977
