<!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.6"/>
<title>ICU 53.1: udateintervalformat.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">ICU 53.1
 <span id="projectnumber">53.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- 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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_50278085fbfb203a4ae8d13ac447741e.html">i18n</a></li><li class="navelem"><a class="el" href="dir_47d86980f74387e1e780cfdfbee4bf19.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">udateintervalformat.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>C API: Format a date interval.
<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="umisc_8h_source.html">unicode/umisc.h</a>"</code><br/>
<code>#include "<a class="el" href="localpointer_8h_source.html">unicode/localpointer.h</a>"</code><br/>
</div>
<p><a href="udateintervalformat_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:a884c867de15c3243320a1edc2395c019"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a></td></tr>
<tr class="memdesc:a884c867de15c3243320a1edc2395c019"><td class="mdescLeft"> </td><td class="mdescRight">C typedef for struct UDateIntervalFormat. <a href="#a884c867de15c3243320a1edc2395c019">More...</a><br/></td></tr>
<tr class="separator:a884c867de15c3243320a1edc2395c019"><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:aa21dbefbf0a7f81d669e389710a3922d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="udateintervalformat_8h.html#aa21dbefbf0a7f81d669e389710a3922d">udtitvfmt_open</a> (const char *locale, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *skeleton, int32_t skeletonLength, const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *tzID, int32_t tzIDLength, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:aa21dbefbf0a7f81d669e389710a3922d"><td class="mdescLeft"> </td><td class="mdescRight">Open a new UDateIntervalFormat object using the predefined rules for a given locale plus a specified skeleton. <a href="#aa21dbefbf0a7f81d669e389710a3922d">More...</a><br/></td></tr>
<tr class="separator:aa21dbefbf0a7f81d669e389710a3922d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa845819b77462926233d234d2806456e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="udateintervalformat_8h.html#aa845819b77462926233d234d2806456e">udtitvfmt_close</a> (<a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> *formatter)</td></tr>
<tr class="memdesc:aa845819b77462926233d234d2806456e"><td class="mdescLeft"> </td><td class="mdescRight">Close a UDateIntervalFormat object. <a href="#aa845819b77462926233d234d2806456e">More...</a><br/></td></tr>
<tr class="separator:aa845819b77462926233d234d2806456e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c5f0e8265cf22d806f98c048b454420"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="udateintervalformat_8h.html#a9c5f0e8265cf22d806f98c048b454420">udtitvfmt_format</a> (const <a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> *formatter, <a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> fromDate, <a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> toDate, <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> *result, int32_t resultCapacity, <a class="el" href="structUFieldPosition.html">UFieldPosition</a> *position, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> *status)</td></tr>
<tr class="memdesc:a9c5f0e8265cf22d806f98c048b454420"><td class="mdescLeft"> </td><td class="mdescRight">Formats a date/time range using the conventions established for the UDateIntervalFormat object. <a href="#a9c5f0e8265cf22d806f98c048b454420">More...</a><br/></td></tr>
<tr class="separator:a9c5f0e8265cf22d806f98c048b454420"><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: Format a date interval. </p>
<p>A UDateIntervalFormat is used to format the range between two UDate values in a locale-sensitive way, using a skeleton that specifies the precision and completeness of the information to show. If the range smaller than the resolution specified by the skeleton, a single date format will be produced. If the range is larger than the format specified by the skeleton, a locale-specific fallback will be used to format the items missing from the skeleton.</p>
<p>For example, if the range is 2010-03-04 07:56 - 2010-03-04 19:56 (12 hours)</p>
<ul>
<li>The skeleton jm will produce for en_US, "7:56 AM - 7:56 PM" for en_GB, "7:56 - 19:56"</li>
<li>The skeleton MMMd will produce for en_US, "Mar 4" for en_GB, "4 Mar" If the range is 2010-03-04 07:56 - 2010-03-08 16:11 (4 days, 8 hours, 15 minutes)</li>
<li>The skeleton jm will produce for en_US, "3/4/2010 7:56 AM - 3/8/2010 4:11 PM" for en_GB, "4/3/2010 7:56 - 8/3/2010 16:11"</li>
<li>The skeleton MMMd will produce for en_US, "Mar 4-8" for en_GB, "4-8 Mar"</li>
</ul>
<p>Note: the "-" characters in the above sample output will actually be Unicode 2013, EN_DASH, in all but the last example.</p>
<p>Note, in ICU 4.4 the standard skeletons for which date interval format data is usually available are as follows; best results will be obtained by using skeletons from this set, or those formed by combining these standard skeletons (note that for these skeletons, the length of digit field such as d, y, or M vs MM is irrelevant (but for non-digit fields such as MMM vs MMMM it is relevant). Note that a skeleton involving h or H generally explicitly requests that time style (12- or 24-hour time respectively). For a skeleton that requests the locale's default time style (h or H), use 'j' instead of h or H. h, H, hm, Hm, hv, Hv, hmv, Hmv, d, M, MMM, MMMM, Md, MMMd, MEd, MMMEd, y, yM, yMMM, yMMMM, yMd, yMMMd, yMEd, yMMMEd</p>
<p>Locales for which ICU 4.4 seems to have a reasonable amount of this data include: af, am, ar, be, bg, bn, ca, cs, da, de (_AT), el, en (_AU,_CA,_GB,_IE,_IN...), eo, es (_AR,_CL,_CO,...,_US) et, fa, fi, fo, fr (_BE,_CH,_CA), fur, gsw, he, hr, hu, hy, is, it (_CH), ja, kk, km, ko, lt, lv, mk, ml, mt, nb, nl )_BE), nn, pl, pt (_PT), rm, ro, ru (_UA), sk, sl, so, sq, sr, sr_Latn, sv, th, to, tr, uk, ur, vi, zh (_SG), zh_Hant (_HK,_MO) </p>
<p>Definition in file <a class="el" href="udateintervalformat_8h_source.html">udateintervalformat.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a884c867de15c3243320a1edc2395c019"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> <a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>C typedef for struct UDateIntervalFormat. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004748">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
<p>Definition at line <a class="el" href="udateintervalformat_8h_source.html#l00080">80</a> of file <a class="el" href="udateintervalformat_8h_source.html">udateintervalformat.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aa845819b77462926233d234d2806456e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void udtitvfmt_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> * </td>
<td class="paramname"><em>formatter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a UDateIntervalFormat object. </p>
<p>Once closed it may no longer be used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">formatter</td><td>The UDateIntervalFormat object to close. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004750">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a9c5f0e8265cf22d806f98c048b454420"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t udtitvfmt_format </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a> * </td>
<td class="paramname"><em>formatter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> </td>
<td class="paramname"><em>fromDate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a> </td>
<td class="paramname"><em>toDate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>resultCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structUFieldPosition.html">UFieldPosition</a> * </td>
<td class="paramname"><em>position</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>Formats a date/time range using the conventions established for the UDateIntervalFormat object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">formatter</td><td>The UDateIntervalFormat object specifying the format conventions. </td></tr>
<tr><td class="paramname">fromDate</td><td>The starting point of the range. </td></tr>
<tr><td class="paramname">toDate</td><td>The ending point of the range. </td></tr>
<tr><td class="paramname">result</td><td>A pointer to a buffer to receive the formatted range. </td></tr>
<tr><td class="paramname">resultCapacity</td><td>The maximum size of result. </td></tr>
<tr><td class="paramname">position</td><td>A pointer to a <a class="el" href="structUFieldPosition.html" title="A struct representing a range of text containing a specific field. ">UFieldPosition</a>. On input, position->field is read. On output, position->beginIndex and position->endIndex indicate the beginning and ending indices of field number position->field, if such a field exists. This parameter may be NULL, in which case no field position data is returned. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The total buffer size needed; if greater than resultLength, the output was truncated. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004751">Stable:</a></b></dt><dd>ICU 4.8 </dd></dl>
</div>
</div>
<a class="anchor" id="aa21dbefbf0a7f81d669e389710a3922d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="udateintervalformat_8h.html#a884c867de15c3243320a1edc2395c019">UDateIntervalFormat</a>* udtitvfmt_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>skeleton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>skeletonLength</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> * </td>
<td class="paramname"><em>tzID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>tzIDLength</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>Open a new UDateIntervalFormat object using the predefined rules for a given locale plus a specified skeleton. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">locale</td><td>The locale for whose rules should be used; may be NULL for default locale. </td></tr>
<tr><td class="paramname">skeleton</td><td>A pattern containing only the fields desired for the interval format, for example "Hm", "yMMMd", or "yMMMEdHm". </td></tr>
<tr><td class="paramname">skeletonLength</td><td>The length of skeleton; may be -1 if the skeleton is zero-terminated. </td></tr>
<tr><td class="paramname">tzID</td><td>A timezone ID specifying the timezone to use. If 0, use the default timezone. </td></tr>
<tr><td class="paramname">tzIDLength</td><td>The length of tzID, or -1 if null-terminated. If 0, use the default timezone. </td></tr>
<tr><td class="paramname">status</td><td>A pointer to a UErrorCode to receive any errors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a UDateIntervalFormat object for the specified locale, or NULL if an error occurred. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable004749">Stable:</a></b></dt><dd>ICU 4.8 </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.6
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-updates
>
by-pkgid
>
67d6f1fcdf59eeb6f1363fc33c40091c
>
files
>
1330
