ICU 67.1 67.1
udateintervalformat.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*****************************************************************************************
5* Copyright (C) 2010-2012,2015 International Business Machines
6* Corporation and others. All Rights Reserved.
7*****************************************************************************************
8*/
9
10#ifndef UDATEINTERVALFORMAT_H
11#define UDATEINTERVALFORMAT_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_FORMATTING
16
17#include "unicode/ucal.h"
18#include "unicode/umisc.h"
21
78
85
92
118udtitvfmt_open(const char* locale,
119 const UChar* skeleton,
120 int32_t skeletonLength,
121 const UChar* tzID,
122 int32_t tzIDLength,
123 UErrorCode* status);
124
131U_STABLE void U_EXPORT2
133
145
168U_CAPI const UFormattedValue* U_EXPORT2
170
177U_CAPI void U_EXPORT2
179
180
181#if U_SHOW_CPLUSPLUS_API
182
183U_NAMESPACE_BEGIN
184
195
206
207U_NAMESPACE_END
208
209#endif
210
211
241U_STABLE int32_t U_EXPORT2
243 UDate fromDate,
244 UDate toDate,
245 UChar* result,
246 int32_t resultCapacity,
247 UFieldPosition* position,
248 UErrorCode* status);
249
250
251#ifndef U_HIDE_DRAFT_API
268U_DRAFT void U_EXPORT2
270 const UDateIntervalFormat* formatter,
271 UDate fromDate,
272 UDate toDate,
274 UErrorCode* status);
275
292
293U_DRAFT void U_EXPORT2
295 const UDateIntervalFormat* formatter,
296 UCalendar* fromCalendar,
297 UCalendar* toCalendar,
299 UErrorCode* status);
300#endif /* U_HIDE_DRAFT_API */
301
302
303#endif /* #if !UCONFIG_NO_FORMATTING */
304
305#endif
"Smart pointer" class, closes a UDateIntervalFormat via udtitvfmt_close().
"Smart pointer" class, closes a UFormattedDateInterval via udtitvfmt_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
A struct representing a range of text containing a specific field.
Definition umisc.h:34
C API: Calendar.
void * UCalendar
A calendar.
Definition ucal.h:169
U_CAPI UFormattedDateInterval * udtitvfmt_openResult(UErrorCode *ec)
Creates an object to hold the result of a UDateIntervalFormat operation.
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.
U_CAPI const UFormattedValue * udtitvfmt_resultAsValue(const UFormattedDateInterval *uresult, UErrorCode *ec)
Returns a representation of a UFormattedDateInterval as a UFormattedValue, which can be subsequently ...
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 ...
struct UFormattedDateInterval UFormattedDateInterval
Opaque struct to contain the results of a UDateIntervalFormat operation.
struct UDateIntervalFormat UDateIntervalFormat
C typedef for struct UDateIntervalFormat.
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.
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.
void udtitvfmt_close(UDateIntervalFormat *formatter)
Close a UDateIntervalFormat object.
U_CAPI void udtitvfmt_closeResult(UFormattedDateInterval *uresult)
Releases the UFormattedDateInterval created by udtitvfmt_openResult().
C API: Abstract operations for localized strings.
struct UFormattedValue UFormattedValue
An abstract formatted value: a string with associated field attributes.
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:376
#define U_DRAFT
This is used to declare a function as a draft public ICU C API.
Definition umachine.h:113
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:109
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:111
C API:misc definitions.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
double UDate
Date and Time data type.
Definition utypes.h:203