ICU 69.1  69.1
Namespaces | Typedefs | Functions
udateintervalformat.h File Reference

C API: Format a date interval. More...

#include "unicode/utypes.h"
#include "unicode/ucal.h"
#include "unicode/umisc.h"
#include "unicode/uformattedvalue.h"
#include "unicode/udisplaycontext.h"
#include "unicode/localpointer.h"

Go to the source code of this file.

Namespaces

 icu
 File coll.h.
 

Typedefs

typedef struct UDateIntervalFormat UDateIntervalFormat
 C typedef for struct UDateIntervalFormat. More...
 
typedef struct UFormattedDateInterval UFormattedDateInterval
 Opaque struct to contain the results of a UDateIntervalFormat operation. More...
 

Functions

U_CAPI UDateIntervalFormatudtitvfmt_open (const char *locale, const UChar *skeleton, int32_t skeletonLength, const UChar *tzID, int32_t tzIDLength, UErrorCode *status)
 Open a new UDateIntervalFormat object using the predefined rules for a given locale plus a specified skeleton. More...
 
U_CAPI void udtitvfmt_close (UDateIntervalFormat *formatter)
 Close a UDateIntervalFormat object. More...
 
U_CAPI UFormattedDateIntervaludtitvfmt_openResult (UErrorCode *ec)
 Creates an object to hold the result of a UDateIntervalFormat operation. More...
 
U_CAPI const UFormattedValueudtitvfmt_resultAsValue (const UFormattedDateInterval *uresult, UErrorCode *ec)
 Returns a representation of a UFormattedDateInterval as a UFormattedValue, which can be subsequently passed to any API requiring that type. More...
 
U_CAPI void udtitvfmt_closeResult (UFormattedDateInterval *uresult)
 Releases the UFormattedDateInterval created by udtitvfmt_openResult(). More...
 
U_CAPI int32_t udtitvfmt_format (const UDateIntervalFormat *formatter, UDate fromDate, UDate toDate, UChar *result, int32_t resultCapacity, UFieldPosition *position, UErrorCode *status)
 Formats a date/time range using the conventions established for the UDateIntervalFormat object. More...
 
U_CAPI void udtitvfmt_formatToResult (const UDateIntervalFormat *formatter, UDate fromDate, UDate toDate, UFormattedDateInterval *result, UErrorCode *status)
 Formats a date/time range using the conventions established for the UDateIntervalFormat object. More...
 
U_CAPI void udtitvfmt_formatCalendarToResult (const UDateIntervalFormat *formatter, UCalendar *fromCalendar, UCalendar *toCalendar, UFormattedDateInterval *result, UErrorCode *status)
 Formats a date/time range using the conventions established for the UDateIntervalFormat object. More...
 
U_CAPI void udtitvfmt_setContext (UDateIntervalFormat *formatter, UDisplayContext value, UErrorCode *status)
 Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE. More...
 
U_CAPI UDisplayContext udtitvfmt_getContext (const UDateIntervalFormat *formatter, UDisplayContextType type, UErrorCode *status)
 Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION. More...
 

Detailed Description

C API: Format a date interval.

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.

For example, if the range is 2010-03-04 07:56 - 2010-03-04 19:56 (12 hours)

Note: the "-" characters in the above sample output will actually be Unicode 2013, EN_DASH, in all but the last example.

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

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)

Definition in file udateintervalformat.h.

Typedef Documentation

◆ UDateIntervalFormat

C typedef for struct UDateIntervalFormat.

Stable:
ICU 4.8

Definition at line 1 of file udateintervalformat.h.

◆ UFormattedDateInterval

Opaque struct to contain the results of a UDateIntervalFormat operation.

Stable:
ICU 64

Definition at line 1 of file udateintervalformat.h.

Function Documentation

◆ udtitvfmt_close()

U_CAPI void udtitvfmt_close ( UDateIntervalFormat formatter)

Close a UDateIntervalFormat object.

Once closed it may no longer be used.

Parameters
formatterThe UDateIntervalFormat object to close.
Stable:
ICU 4.8

◆ udtitvfmt_closeResult()

U_CAPI void udtitvfmt_closeResult ( UFormattedDateInterval uresult)

Releases the UFormattedDateInterval created by udtitvfmt_openResult().

Parameters
uresultThe object to release.
Stable:
ICU 64

◆ udtitvfmt_format()

U_CAPI int32_t udtitvfmt_format ( const UDateIntervalFormat formatter,
UDate  fromDate,
UDate  toDate,
UChar result,
int32_t  resultCapacity,
UFieldPosition position,
UErrorCode status 
)

Formats a date/time range using the conventions established for the UDateIntervalFormat object.

Parameters
formatterThe UDateIntervalFormat object specifying the format conventions.
fromDateThe starting point of the range.
toDateThe ending point of the range.
resultA pointer to a buffer to receive the formatted range.
resultCapacityThe maximum size of result.
positionA pointer to a UFieldPosition. 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. There may be multiple instances of a given field type in an interval format; in this case the position indices refer to the first instance.
statusA pointer to a UErrorCode to receive any errors.
Returns
The total buffer size needed; if greater than resultLength, the output was truncated.
Stable:
ICU 4.8

◆ udtitvfmt_formatCalendarToResult()

U_CAPI void udtitvfmt_formatCalendarToResult ( const UDateIntervalFormat formatter,
UCalendar fromCalendar,
UCalendar toCalendar,
UFormattedDateInterval result,
UErrorCode status 
)

Formats a date/time range using the conventions established for the UDateIntervalFormat object.

Parameters
formatterThe UDateIntervalFormat object specifying the format conventions.
fromCalendarThe starting point of the range.
toCalendarThe ending point of the range.
resultThe UFormattedDateInterval to contain the result of the formatting operation.
statusA pointer to a UErrorCode to receive any errors.
Stable:
ICU 67

◆ udtitvfmt_formatToResult()

U_CAPI void udtitvfmt_formatToResult ( const UDateIntervalFormat formatter,
UDate  fromDate,
UDate  toDate,
UFormattedDateInterval result,
UErrorCode status 
)

Formats a date/time range using the conventions established for the UDateIntervalFormat object.

Parameters
formatterThe UDateIntervalFormat object specifying the format conventions.
fromDateThe starting point of the range.
toDateThe ending point of the range.
resultThe UFormattedDateInterval to contain the result of the formatting operation.
statusA pointer to a UErrorCode to receive any errors.
Stable:
ICU 67

◆ udtitvfmt_getContext()

U_CAPI UDisplayContext udtitvfmt_getContext ( const UDateIntervalFormat formatter,
UDisplayContextType  type,
UErrorCode status 
)

Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.

Parameters
formatterThe formatter to query.
typeThe UDisplayContextType whose value to return
statusA pointer to an UErrorCode to receive any errors
Returns
The UDisplayContextValue for the specified type.
Draft:
This API may be changed in the future versions and was introduced in ICU 68

◆ udtitvfmt_open()

U_CAPI UDateIntervalFormat* udtitvfmt_open ( const char *  locale,
const UChar skeleton,
int32_t  skeletonLength,
const UChar tzID,
int32_t  tzIDLength,
UErrorCode status 
)

Open a new UDateIntervalFormat object using the predefined rules for a given locale plus a specified skeleton.

Parameters
localeThe locale for whose rules should be used; may be NULL for default locale.
skeletonA pattern containing only the fields desired for the interval format, for example "Hm", "yMMMd", or "yMMMEdHm".
skeletonLengthThe length of skeleton; may be -1 if the skeleton is zero-terminated.
tzIDA timezone ID specifying the timezone to use. If 0, use the default timezone.
tzIDLengthThe length of tzID, or -1 if null-terminated. If 0, use the default timezone.
statusA pointer to a UErrorCode to receive any errors.
Returns
A pointer to a UDateIntervalFormat object for the specified locale, or NULL if an error occurred.
Stable:
ICU 4.8

◆ udtitvfmt_openResult()

U_CAPI UFormattedDateInterval* udtitvfmt_openResult ( UErrorCode ec)

Creates an object to hold the result of a UDateIntervalFormat operation.

The object can be used repeatedly; it is cleared whenever passed to a format function.

Parameters
ecSet if an error occurs.
Returns
A pointer needing ownership.
Stable:
ICU 64

◆ udtitvfmt_resultAsValue()

U_CAPI const UFormattedValue* udtitvfmt_resultAsValue ( const UFormattedDateInterval uresult,
UErrorCode ec 
)

Returns a representation of a UFormattedDateInterval as a UFormattedValue, which can be subsequently passed to any API requiring that type.

The returned object is owned by the UFormattedDateInterval and is valid only as long as the UFormattedDateInterval is present and unchanged in memory.

You can think of this method as a cast between types.

When calling ufmtval_nextPosition(): The fields are returned from left to right. The special field category UFIELD_CATEGORY_DATE_INTERVAL_SPAN is used to indicate which datetime primitives came from which arguments: 0 means fromCalendar, and 1 means toCalendar. The span category will always occur before the corresponding fields in UFIELD_CATEGORY_DATE in the ufmtval_nextPosition() iterator.

Parameters
uresultThe object containing the formatted string.
ecSet if an error occurs.
Returns
A UFormattedValue owned by the input object.
Stable:
ICU 64

◆ udtitvfmt_setContext()

U_CAPI void udtitvfmt_setContext ( UDateIntervalFormat formatter,
UDisplayContext  value,
UErrorCode status 
)

Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.

This causes the formatted result to be capitalized appropriately for the context in which it is intended to be used, considering both the locale and the type of field at the beginning of the formatted result.

Parameters
formatterThe formatter for which to set a UDisplayContext value.
valueThe UDisplayContext value to set.
statusA pointer to an UErrorCode to receive any errors
Draft:
This API may be changed in the future versions and was introduced in ICU 68