ICU 50.1.2
50.1.2
|
C API: DateFormat. More...
#include "unicode/utypes.h"
#include "unicode/localpointer.h"
#include "unicode/ucal.h"
#include "unicode/unum.h"
#include "unicode/udisplaycontext.h"
Go to the source code of this file.
Namespaces | |
icu | |
File coll.h. | |
Macros | |
#define | UDAT_YEAR "y" |
Constant for date skeleton with year. More... | |
#define | UDAT_QUARTER "QQQQ" |
Constant for date skeleton with quarter. More... | |
#define | UDAT_ABBR_QUARTER "QQQ" |
Constant for date skeleton with abbreviated quarter. More... | |
#define | UDAT_YEAR_QUARTER "yQQQQ" |
Constant for date skeleton with year and quarter. More... | |
#define | UDAT_YEAR_ABBR_QUARTER "yQQQ" |
Constant for date skeleton with year and abbreviated quarter. More... | |
#define | UDAT_MONTH "MMMM" |
Constant for date skeleton with month. More... | |
#define | UDAT_ABBR_MONTH "MMM" |
Constant for date skeleton with abbreviated month. More... | |
#define | UDAT_NUM_MONTH "M" |
Constant for date skeleton with numeric month. More... | |
#define | UDAT_YEAR_MONTH "yMMMM" |
Constant for date skeleton with year and month. More... | |
#define | UDAT_YEAR_ABBR_MONTH "yMMM" |
Constant for date skeleton with year and abbreviated month. More... | |
#define | UDAT_YEAR_NUM_MONTH "yM" |
Constant for date skeleton with year and numeric month. More... | |
#define | UDAT_DAY "d" |
Constant for date skeleton with day. More... | |
#define | UDAT_YEAR_MONTH_DAY "yMMMMd" |
Constant for date skeleton with year, month, and day. More... | |
#define | UDAT_YEAR_ABBR_MONTH_DAY "yMMMd" |
Constant for date skeleton with year, abbreviated month, and day. More... | |
#define | UDAT_YEAR_NUM_MONTH_DAY "yMd" |
Constant for date skeleton with year, numeric month, and day. More... | |
#define | UDAT_WEEKDAY "EEEE" |
Constant for date skeleton with weekday. More... | |
#define | UDAT_ABBR_WEEKDAY "E" |
Constant for date skeleton with abbreviated weekday. More... | |
#define | UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd" |
Constant for date skeleton with year, month, weekday, and day. More... | |
#define | UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd" |
Constant for date skeleton with year, abbreviated month, weekday, and day. More... | |
#define | UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd" |
Constant for date skeleton with year, numeric month, weekday, and day. More... | |
#define | UDAT_MONTH_DAY "MMMMd" |
Constant for date skeleton with long month and day. More... | |
#define | UDAT_ABBR_MONTH_DAY "MMMd" |
Constant for date skeleton with abbreviated month and day. More... | |
#define | UDAT_NUM_MONTH_DAY "Md" |
Constant for date skeleton with numeric month and day. More... | |
#define | UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd" |
Constant for date skeleton with month, weekday, and day. More... | |
#define | UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd" |
Constant for date skeleton with abbreviated month, weekday, and day. More... | |
#define | UDAT_NUM_MONTH_WEEKDAY_DAY "MEd" |
Constant for date skeleton with numeric month, weekday, and day. More... | |
#define | UDAT_HOUR "j" |
Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24). More... | |
#define | UDAT_HOUR24 "H" |
Constant for date skeleton with hour in 24-hour presentation. More... | |
#define | UDAT_MINUTE "m" |
Constant for date skeleton with minute. More... | |
#define | UDAT_HOUR_MINUTE "jm" |
Constant for date skeleton with hour and minute, with the locale's preferred hour format (12 or 24). More... | |
#define | UDAT_HOUR24_MINUTE "Hm" |
Constant for date skeleton with hour and minute in 24-hour presentation. More... | |
#define | UDAT_SECOND "s" |
Constant for date skeleton with second. More... | |
#define | UDAT_HOUR_MINUTE_SECOND "jms" |
Constant for date skeleton with hour, minute, and second, with the locale's preferred hour format (12 or 24). More... | |
#define | UDAT_HOUR24_MINUTE_SECOND "Hms" |
Constant for date skeleton with hour, minute, and second in 24-hour presentation. More... | |
#define | UDAT_MINUTE_SECOND "ms" |
Constant for date skeleton with minute and second. More... | |
#define | UDAT_LOCATION_TZ "VVVV" |
Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_GENERIC_TZ "vvvv" |
Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_ABBR_GENERIC_TZ "v" |
Constant for generic non-location format, abbreviated if possible, such as PT; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_SPECIFIC_TZ "zzzz" |
Constant for specific non-location format, such as Pacific Daylight Time; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_ABBR_SPECIFIC_TZ "z" |
Constant for specific non-location format, abbreviated if possible, such as PDT; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_ABBR_UTC_TZ "ZZZZ" |
Constant for localized GMT/UTC format, such as GMT+8:00 or HPG-8:00; used in combinations date + time + zone, or time + zone. More... | |
#define | UDAT_STANDALONE_MONTH "LLLL" |
Constant for date skeleton with standalone month. More... | |
#define | UDAT_ABBR_STANDALONE_MONTH "LLL" |
Constant for date skeleton with standalone abbreviated month. More... | |
#define | UDAT_HOUR_MINUTE_GENERIC_TZ "jmv" |
Constant for date skeleton with hour, minute, and generic timezone. More... | |
#define | UDAT_HOUR_MINUTE_TZ "jmz" |
Constant for date skeleton with hour, minute, and timezone. More... | |
#define | UDAT_HOUR_GENERIC_TZ "jv" |
Constant for date skeleton with hour and generic timezone. More... | |
#define | UDAT_HOUR_TZ "jz" |
Constant for date skeleton with hour and timezone. More... | |
Typedefs | |
typedef void * | UDateFormat |
A date formatter. More... | |
typedef enum UDateFormatStyle | UDateFormatStyle |
The possible date/time format styles. More... | |
typedef enum UDateFormatField | UDateFormatField |
FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat. More... | |
typedef enum UDateFormatSymbolType | UDateFormatSymbolType |
The possible types of date format symbols. More... | |
typedef struct UDateFormatSymbols | UDateFormatSymbols |
Date format symbols. More... | |
typedef UDateFormat *(* | UDateFormatOpener )(UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char *locale, const UChar *tzID, int32_t tzIDLength, const UChar *pattern, int32_t patternLength, UErrorCode *status) |
Functions | |
UCalendarDateFields | udat_toCalendarDateField (UDateFormatField field) |
Maps from a UDateFormatField to the corresponding UCalendarDateFields. More... | |
UDateFormat * | udat_open (UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char *locale, const UChar *tzID, int32_t tzIDLength, const UChar *pattern, int32_t patternLength, UErrorCode *status) |
Open a new UDateFormat for formatting and parsing dates and times. More... | |
void | udat_close (UDateFormat *format) |
Close a UDateFormat. More... | |
UDateFormat * | udat_clone (const UDateFormat *fmt, UErrorCode *status) |
Open a copy of a UDateFormat. More... | |
int32_t | udat_format (const UDateFormat *format, UDate dateToFormat, UChar *result, int32_t resultLength, UFieldPosition *position, UErrorCode *status) |
Format a date using an UDateFormat. More... | |
UDate | udat_parse (const UDateFormat *format, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status) |
Parse a string into an date/time using a UDateFormat. More... | |
void | udat_parseCalendar (const UDateFormat *format, UCalendar *calendar, const UChar *text, int32_t textLength, int32_t *parsePos, UErrorCode *status) |
Parse a string into an date/time using a UDateFormat. More... | |
UBool | udat_isLenient (const UDateFormat *fmt) |
Determine if an UDateFormat will perform lenient parsing. More... | |
void | udat_setLenient (UDateFormat *fmt, UBool isLenient) |
Specify whether an UDateFormat will perform lenient parsing. More... | |
const UCalendar * | udat_getCalendar (const UDateFormat *fmt) |
Get the UCalendar associated with an UDateFormat. More... | |
void | udat_setCalendar (UDateFormat *fmt, const UCalendar *calendarToSet) |
Set the UCalendar associated with an UDateFormat. More... | |
const UNumberFormat * | udat_getNumberFormat (const UDateFormat *fmt) |
Get the UNumberFormat associated with an UDateFormat. More... | |
void | udat_setNumberFormat (UDateFormat *fmt, const UNumberFormat *numberFormatToSet) |
Set the UNumberFormat associated with an UDateFormat. More... | |
const char * | udat_getAvailable (int32_t localeIndex) |
Get a locale for which date/time formatting patterns are available. More... | |
int32_t | udat_countAvailable (void) |
Determine how many locales have date/time formatting patterns available. More... | |
UDate | udat_get2DigitYearStart (const UDateFormat *fmt, UErrorCode *status) |
Get the year relative to which all 2-digit years are interpreted. More... | |
void | udat_set2DigitYearStart (UDateFormat *fmt, UDate d, UErrorCode *status) |
Set the year relative to which all 2-digit years will be interpreted. More... | |
int32_t | udat_toPattern (const UDateFormat *fmt, UBool localized, UChar *result, int32_t resultLength, UErrorCode *status) |
Extract the pattern from a UDateFormat. More... | |
void | udat_applyPattern (UDateFormat *format, UBool localized, const UChar *pattern, int32_t patternLength) |
Set the pattern used by an UDateFormat. More... | |
int32_t | udat_getSymbols (const UDateFormat *fmt, UDateFormatSymbolType type, int32_t symbolIndex, UChar *result, int32_t resultLength, UErrorCode *status) |
Get the symbols associated with an UDateFormat. More... | |
int32_t | udat_countSymbols (const UDateFormat *fmt, UDateFormatSymbolType type) |
Count the number of particular symbols for an UDateFormat. More... | |
void | udat_setSymbols (UDateFormat *format, UDateFormatSymbolType type, int32_t symbolIndex, UChar *value, int32_t valueLength, UErrorCode *status) |
Set the symbols associated with an UDateFormat. More... | |
const char * | udat_getLocaleByType (const UDateFormat *fmt, ULocDataLocaleType type, UErrorCode *status) |
Get the locale for this date format object. More... | |
void | udat_setContext (UDateFormat *fmt, UDisplayContext value, UErrorCode *status) |
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE. More... | |
UDisplayContext | udat_getContext (UDateFormat *fmt, UDisplayContextType type, UErrorCode *status) |
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION. More... | |
int32_t | udat_toPatternRelativeDate (const UDateFormat *fmt, UChar *result, int32_t resultLength, UErrorCode *status) |
Extract the date pattern from a UDateFormat set for relative date formatting. More... | |
int32_t | udat_toPatternRelativeTime (const UDateFormat *fmt, UChar *result, int32_t resultLength, UErrorCode *status) |
Extract the time pattern from a UDateFormat set for relative date formatting. More... | |
void | udat_applyPatternRelative (UDateFormat *format, const UChar *datePattern, int32_t datePatternLength, const UChar *timePattern, int32_t timePatternLength, UErrorCode *status) |
Set the date & time patterns used by a UDateFormat set for relative date formatting. More... | |
void | udat_registerOpener (UDateFormatOpener opener, UErrorCode *status) |
Register a provider factory. More... | |
UDateFormatOpener | udat_unregisterOpener (UDateFormatOpener opener, UErrorCode *status) |
Un-Register a provider factory. More... | |
C API: DateFormat.
Date Format C API consists of functions that convert dates and times from their internal representations to textual form and back again in a language-independent manner. Converting from the internal representation (milliseconds since midnight, January 1, 1970) to text is known as "formatting," and converting from text to millis is known as "parsing." We currently define only one concrete structure UDateFormat, which can handle pretty much all normal date formatting and parsing actions.
Date Format helps you to format and parse dates for any locale. Your code can be completely independent of the locale conventions for months, days of the week, or even the calendar format: lunar vs. solar.
To format a date for the current Locale with default time and date style, use one of the static factory methods:
* UErrorCode status = U_ZERO_ERROR;* UChar *myString;* int32_t myStrlen = 0;* if (status==U_BUFFER_OVERFLOW_ERROR){* status=U_ZERO_ERROR;* udat_format(dfmt, myDate, myString, myStrlen+1, NULL, &status);* }*
If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.
* UErrorCode status = U_ZERO_ERROR;* int32_t i, myStrlen = 0;* UChar* myString;* char buffer[1024];* UDate myDateArr[] = { 0.0, 100000000.0, 2000000000.0 }; // test values* for (i = 0; i < 3; i++) {* if(status == U_BUFFER_OVERFLOW_ERROR){* status = U_ZERO_ERROR;* udat_format(df, myDateArr[i], myString, myStrlen+1, NULL, &status);* printf("%s\n", u_austrcpy(buffer, myString) );* free(myString);* }* }*
To get specific fields of a date, you can use UFieldPosition to get specific fields.
* UErrorCode status = U_ZERO_ERROR;* UFieldPosition pos;* UChar *myString;* int32_t myStrlen = 0;* char buffer[1024];** pos.field = 1; // Same as the DateFormat::EField enum* myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, &pos, &status);* if (status==U_BUFFER_OVERFLOW_ERROR){* status=U_ZERO_ERROR;* udat_format(dfmt, myDate, myString, myStrlen+1, &pos, &status);* }* printf("date format: %s\n", u_austrcpy(buffer, myString));* buffer[pos.endIndex] = 0; // NULL terminate the string.* printf("UFieldPosition position equals %s\n", &buffer[pos.beginIndex]);*
To format a date for a different Locale, specify it in the call to udat_open()
*
You can use a DateFormat API udat_parse() to parse.
You can pass in different options for the arguments for date and time style to control the length of the result; from SHORT to MEDIUM to LONG to FULL. The exact result depends on the locale, but generally: see UDateFormatStyle for more details
You can also set the time zone on the format if you wish.
You can also use forms of the parse and format methods with Parse Position and UFieldPosition to allow you to
Definition in file udat.h.
#define UDAT_ABBR_GENERIC_TZ "v" |
Constant for generic non-location format, abbreviated if possible, such as PT; used in combinations date + time + zone, or time + zone.
#define UDAT_ABBR_MONTH "MMM" |
#define UDAT_ABBR_MONTH_DAY "MMMd" |
#define UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd" |
#define UDAT_ABBR_QUARTER "QQQ" |
#define UDAT_ABBR_SPECIFIC_TZ "z" |
Constant for specific non-location format, abbreviated if possible, such as PDT; used in combinations date + time + zone, or time + zone.
#define UDAT_ABBR_STANDALONE_MONTH "LLL" |
Constant for date skeleton with standalone abbreviated month.
#define UDAT_ABBR_UTC_TZ "ZZZZ" |
Constant for localized GMT/UTC format, such as GMT+8:00 or HPG-8:00; used in combinations date + time + zone, or time + zone.
#define UDAT_ABBR_WEEKDAY "E" |
#define UDAT_DAY "d" |
#define UDAT_GENERIC_TZ "vvvv" |
Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone.
#define UDAT_HOUR "j" |
#define UDAT_HOUR24 "H" |
#define UDAT_HOUR24_MINUTE "Hm" |
#define UDAT_HOUR24_MINUTE_SECOND "Hms" |
#define UDAT_HOUR_GENERIC_TZ "jv" |
Constant for date skeleton with hour and generic timezone.
#define UDAT_HOUR_MINUTE "jm" |
#define UDAT_HOUR_MINUTE_GENERIC_TZ "jmv" |
Constant for date skeleton with hour, minute, and generic timezone.
#define UDAT_HOUR_MINUTE_SECOND "jms" |
#define UDAT_HOUR_MINUTE_TZ "jmz" |
Constant for date skeleton with hour, minute, and timezone.
#define UDAT_HOUR_TZ "jz" |
Constant for date skeleton with hour and timezone.
#define UDAT_LOCATION_TZ "VVVV" |
Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone.
#define UDAT_MINUTE "m" |
#define UDAT_MINUTE_SECOND "ms" |
#define UDAT_MONTH "MMMM" |
#define UDAT_MONTH_DAY "MMMMd" |
#define UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd" |
#define UDAT_NUM_MONTH "M" |
#define UDAT_NUM_MONTH_DAY "Md" |
#define UDAT_NUM_MONTH_WEEKDAY_DAY "MEd" |
#define UDAT_QUARTER "QQQQ" |
#define UDAT_SECOND "s" |
#define UDAT_SPECIFIC_TZ "zzzz" |
Constant for specific non-location format, such as Pacific Daylight Time; used in combinations date + time + zone, or time + zone.
#define UDAT_STANDALONE_MONTH "LLLL" |
Constant for date skeleton with standalone month.
#define UDAT_WEEKDAY "EEEE" |
#define UDAT_YEAR "y" |
#define UDAT_YEAR_ABBR_MONTH "yMMM" |
#define UDAT_YEAR_ABBR_MONTH_DAY "yMMMd" |
#define UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd" |
#define UDAT_YEAR_ABBR_QUARTER "yQQQ" |
#define UDAT_YEAR_MONTH "yMMMM" |
#define UDAT_YEAR_MONTH_DAY "yMMMMd" |
#define UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd" |
#define UDAT_YEAR_NUM_MONTH "yM" |
#define UDAT_YEAR_NUM_MONTH_DAY "yMd" |
#define UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd" |
#define UDAT_YEAR_QUARTER "yQQQQ" |
typedef void* UDateFormat |
typedef enum UDateFormatField UDateFormatField |
FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat.
typedef UDateFormat*( * UDateFormatOpener)(UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char *locale, const UChar *tzID, int32_t tzIDLength, const UChar *pattern, int32_t patternLength, UErrorCode *status) |
typedef enum UDateFormatStyle UDateFormatStyle |
The possible date/time format styles.
typedef struct UDateFormatSymbols UDateFormatSymbols |
typedef enum UDateFormatSymbolType UDateFormatSymbolType |
The possible types of date format symbols.
enum UDateFormatField |
FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat.
Enumerator | |
---|---|
UDAT_ERA_FIELD |
FieldPosition and UFieldPosition selector for 'G' field alignment, corresponding to the UCAL_ERA field.
|
UDAT_YEAR_FIELD |
FieldPosition and UFieldPosition selector for 'y' field alignment, corresponding to the UCAL_YEAR field.
|
UDAT_MONTH_FIELD |
FieldPosition and UFieldPosition selector for 'M' field alignment, corresponding to the UCAL_MONTH field.
|
UDAT_DATE_FIELD |
FieldPosition and UFieldPosition selector for 'd' field alignment, corresponding to the UCAL_DATE field.
|
UDAT_HOUR_OF_DAY1_FIELD |
FieldPosition and UFieldPosition selector for 'k' field alignment, corresponding to the UCAL_HOUR_OF_DAY field. UDAT_HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock. For example, 23:59 + 01:00 results in 24:59.
|
UDAT_HOUR_OF_DAY0_FIELD |
FieldPosition and UFieldPosition selector for 'H' field alignment, corresponding to the UCAL_HOUR_OF_DAY field. UDAT_HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock. For example, 23:59 + 01:00 results in 00:59.
|
UDAT_MINUTE_FIELD |
FieldPosition and UFieldPosition selector for 'm' field alignment, corresponding to the UCAL_MINUTE field.
|
UDAT_SECOND_FIELD |
FieldPosition and UFieldPosition selector for 's' field alignment, corresponding to the UCAL_SECOND field.
|
UDAT_FRACTIONAL_SECOND_FIELD |
FieldPosition and UFieldPosition selector for 'S' field alignment, corresponding to the UCAL_MILLISECOND field. Note: Time formats that use 'S' can display a maximum of three significant digits for fractional seconds, corresponding to millisecond resolution and a fractional seconds sub-pattern of SSS. If the sub-pattern is S or SS, the fractional seconds value will be truncated (not rounded) to the number of display places specified. If the fractional seconds sub-pattern is longer than SSS, the additional display places will be filled with zeros.
|
UDAT_DAY_OF_WEEK_FIELD |
FieldPosition and UFieldPosition selector for 'E' field alignment, corresponding to the UCAL_DAY_OF_WEEK field.
|
UDAT_DAY_OF_YEAR_FIELD |
FieldPosition and UFieldPosition selector for 'D' field alignment, corresponding to the UCAL_DAY_OF_YEAR field.
|
UDAT_DAY_OF_WEEK_IN_MONTH_FIELD |
FieldPosition and UFieldPosition selector for 'F' field alignment, corresponding to the UCAL_DAY_OF_WEEK_IN_MONTH field.
|
UDAT_WEEK_OF_YEAR_FIELD |
FieldPosition and UFieldPosition selector for 'w' field alignment, corresponding to the UCAL_WEEK_OF_YEAR field.
|
UDAT_WEEK_OF_MONTH_FIELD |
FieldPosition and UFieldPosition selector for 'W' field alignment, corresponding to the UCAL_WEEK_OF_MONTH field.
|
UDAT_AM_PM_FIELD |
FieldPosition and UFieldPosition selector for 'a' field alignment, corresponding to the UCAL_AM_PM field.
|
UDAT_HOUR1_FIELD |
FieldPosition and UFieldPosition selector for 'h' field alignment, corresponding to the UCAL_HOUR field. UDAT_HOUR1_FIELD is used for the one-based 12-hour clock. For example, 11:30 PM + 1 hour results in 12:30 AM.
|
UDAT_HOUR0_FIELD |
FieldPosition and UFieldPosition selector for 'K' field alignment, corresponding to the UCAL_HOUR field. UDAT_HOUR0_FIELD is used for the zero-based 12-hour clock. For example, 11:30 PM + 1 hour results in 00:30 AM.
|
UDAT_TIMEZONE_FIELD |
FieldPosition and UFieldPosition selector for 'z' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSET fields.
|
UDAT_YEAR_WOY_FIELD |
FieldPosition and UFieldPosition selector for 'Y' field alignment, corresponding to the UCAL_YEAR_WOY field.
|
UDAT_DOW_LOCAL_FIELD |
FieldPosition and UFieldPosition selector for 'e' field alignment, corresponding to the UCAL_DOW_LOCAL field.
|
UDAT_EXTENDED_YEAR_FIELD |
FieldPosition and UFieldPosition selector for 'u' field alignment, corresponding to the UCAL_EXTENDED_YEAR field.
|
UDAT_JULIAN_DAY_FIELD |
FieldPosition and UFieldPosition selector for 'g' field alignment, corresponding to the UCAL_JULIAN_DAY field.
|
UDAT_MILLISECONDS_IN_DAY_FIELD |
FieldPosition and UFieldPosition selector for 'A' field alignment, corresponding to the UCAL_MILLISECONDS_IN_DAY field.
|
UDAT_TIMEZONE_RFC_FIELD |
FieldPosition and UFieldPosition selector for 'Z' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSET fields.
|
UDAT_TIMEZONE_GENERIC_FIELD |
FieldPosition and UFieldPosition selector for 'v' field alignment, corresponding to the UCAL_ZONE_OFFSET field.
|
UDAT_STANDALONE_DAY_FIELD |
FieldPosition selector for 'c' field alignment, corresponding to the UCAL_DOW_LOCAL field. This displays the stand alone day name, if available.
|
UDAT_STANDALONE_MONTH_FIELD |
FieldPosition selector for 'L' field alignment, corresponding to the UCAL_MONTH field. This displays the stand alone month name, if available.
|
UDAT_QUARTER_FIELD |
FieldPosition selector for "Q" field alignment, corresponding to quarters. This is implemented using the UCAL_MONTH field. This displays the quarter.
|
UDAT_STANDALONE_QUARTER_FIELD |
FieldPosition selector for the "q" field alignment, corresponding to stand-alone quarters. This is implemented using the UCAL_MONTH field. This displays the stand-alone quarter.
|
UDAT_TIMEZONE_SPECIAL_FIELD |
FieldPosition and UFieldPosition selector for 'V' field alignment, corresponding to the UCAL_ZONE_OFFSET field.
|
UDAT_YEAR_NAME_FIELD |
FieldPosition selector for "U" field alignment, corresponding to cyclic year names. This is implemented using the UCAL_YEAR field. This displays the cyclic year name, if available.
|
UDAT_FIELD_COUNT |
Number of FieldPosition and UFieldPosition selectors for DateFormat and UDateFormat. Valid selectors range from 0 to UDAT_FIELD_COUNT-1. This value is subject to change if new fields are defined in the future.
|
enum UDateFormatStyle |
The possible date/time format styles.
Enumerator | |
---|---|
UDAT_FULL |
Full style. |
UDAT_LONG |
Long style. |
UDAT_MEDIUM |
Medium style. |
UDAT_SHORT |
Short style. |
UDAT_DEFAULT |
Default style. |
UDAT_RELATIVE |
Bitfield for relative date. |
UDAT_NONE |
No style. |
UDAT_PATTERN |
Use the pattern given in the parameter to udat_open.
|
UDAT_IGNORE |
|
The possible types of date format symbols.
void udat_applyPattern | ( | UDateFormat * | format, |
UBool | localized, | ||
const UChar * | pattern, | ||
int32_t | patternLength | ||
) |
Set the pattern used by an UDateFormat.
The pattern should follow the pattern syntax rules.
format | The formatter to set. |
localized | TRUE if the pattern is localized, FALSE otherwise. |
pattern | The new pattern |
patternLength | The length of pattern, or -1 if null-terminated. |
void udat_applyPatternRelative | ( | UDateFormat * | format, |
const UChar * | datePattern, | ||
int32_t | datePatternLength, | ||
const UChar * | timePattern, | ||
int32_t | timePatternLength, | ||
UErrorCode * | status | ||
) |
Set the date & time patterns used by a UDateFormat set for relative date formatting.
The patterns should follow the pattern syntax rules.
format | The formatter to set. |
datePattern | The new date pattern |
datePatternLength | The length of datePattern, or -1 if null-terminated. |
timePattern | The new time pattern |
timePatternLength | The length of timePattern, or -1 if null-terminated. |
status | A pointer to a UErrorCode to receive any errors |
UDateFormat* udat_clone | ( | const UDateFormat * | fmt, |
UErrorCode * | status | ||
) |
Open a copy of a UDateFormat.
This function performs a deep copy.
fmt | The format to copy |
status | A pointer to an UErrorCode to receive any errors. |
void udat_close | ( | UDateFormat * | format | ) |
Close a UDateFormat.
Once closed, a UDateFormat may no longer be used.
format | The formatter to close. |
int32_t udat_countAvailable | ( | void | ) |
Determine how many locales have date/time formatting patterns available.
This function is most useful as determining the loop ending condition for calls to udat_getAvailable.
int32_t udat_countSymbols | ( | const UDateFormat * | fmt, |
UDateFormatSymbolType | type | ||
) |
Count the number of particular symbols for an UDateFormat.
This function is most useful as for detemining the loop termination condition for calls to udat_getSymbols.
fmt | The formatter to query. |
type | The type of symbols to count. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS, UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS |
int32_t udat_format | ( | const UDateFormat * | format, |
UDate | dateToFormat, | ||
UChar * | result, | ||
int32_t | resultLength, | ||
UFieldPosition * | position, | ||
UErrorCode * | status | ||
) |
Format a date using an UDateFormat.
The date will be formatted using the conventions specified in udat_open
format | The formatter to use |
dateToFormat | The date to format |
result | A pointer to a buffer to receive the formatted number. |
resultLength | The maximum size of result. |
position | A 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. |
status | A pointer to an UErrorCode to receive any errors |
UDate udat_get2DigitYearStart | ( | const UDateFormat * | fmt, |
UErrorCode * | status | ||
) |
Get the year relative to which all 2-digit years are interpreted.
For example, if the 2-digit start year is 2100, the year 99 will be interpreted as 2199.
fmt | The formatter to query. |
status | A pointer to an UErrorCode to receive any errors |
const char* udat_getAvailable | ( | int32_t | localeIndex | ) |
Get a locale for which date/time formatting patterns are available.
A UDateFormat in a locale returned by this function will perform the correct formatting and parsing for the locale.
localeIndex | The index of the desired locale. |
const UCalendar* udat_getCalendar | ( | const UDateFormat * | fmt | ) |
Get the UCalendar associated with an UDateFormat.
A UDateFormat uses a UCalendar to convert a raw value to, for example, the day of the week.
fmt | The formatter to query. |
UDisplayContext udat_getContext | ( | UDateFormat * | fmt, |
UDisplayContextType | type, | ||
UErrorCode * | status | ||
) |
Get the formatter's UDisplayContext value for the specified UDisplayContextType, such as UDISPCTX_TYPE_CAPITALIZATION.
fmt | The formatter to query. |
type | The UDisplayContextType whose value to return |
status | A pointer to an UErrorCode to receive any errors |
const char* udat_getLocaleByType | ( | const UDateFormat * | fmt, |
ULocDataLocaleType | type, | ||
UErrorCode * | status | ||
) |
Get the locale for this date format object.
You can choose between valid and actual locale.
fmt | The formatter to get the locale from |
type | type of the locale we're looking for (valid or actual) |
status | error code for the operation |
const UNumberFormat* udat_getNumberFormat | ( | const UDateFormat * | fmt | ) |
Get the UNumberFormat associated with an UDateFormat.
A UDateFormat uses a UNumberFormat to format numbers within a date, for example the day number.
fmt | The formatter to query. |
int32_t udat_getSymbols | ( | const UDateFormat * | fmt, |
UDateFormatSymbolType | type, | ||
int32_t | symbolIndex, | ||
UChar * | result, | ||
int32_t | resultLength, | ||
UErrorCode * | status | ||
) |
Get the symbols associated with an UDateFormat.
The symbols are what a UDateFormat uses to represent locale-specific data, for example month or day names.
fmt | The formatter to query. |
type | The type of symbols to get. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS, UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS |
symbolIndex | The desired symbol of type type. |
result | A pointer to a buffer to receive the pattern. |
resultLength | The maximum size of result. |
status | A pointer to an UErrorCode to receive any errors |
UBool udat_isLenient | ( | const UDateFormat * | fmt | ) |
Determine if an UDateFormat will perform lenient parsing.
With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match the pattern. With strict parsing, inputs must match the pattern.
fmt | The formatter to query |
UDateFormat* udat_open | ( | UDateFormatStyle | timeStyle, |
UDateFormatStyle | dateStyle, | ||
const char * | locale, | ||
const UChar * | tzID, | ||
int32_t | tzIDLength, | ||
const UChar * | pattern, | ||
int32_t | patternLength, | ||
UErrorCode * | status | ||
) |
Open a new UDateFormat for formatting and parsing dates and times.
A UDateFormat may be used to format dates in calls to udat_format, and to parse dates in calls to udat_parse.
timeStyle | The style used to format times; one of UDAT_FULL, UDAT_LONG, UDAT_MEDIUM, UDAT_SHORT, UDAT_DEFAULT, or UDAT_NONE (relative time styles are not currently supported). When the pattern parameter is used, pass in UDAT_PATTERN for both timeStyle and dateStyle. |
dateStyle | The style used to format dates; one of UDAT_FULL, UDAT_LONG, UDAT_MEDIUM, UDAT_SHORT, UDAT_DEFAULT, UDAT_FULL_RELATIVE, UDAT_LONG_RELATIVE, UDAT_MEDIUM_RELATIVE, UDAT_SHORT_RELATIVE, or UDAT_NONE. When the pattern parameter is used, pass in UDAT_PATTERN for both timeStyle and dateStyle. As currently implemented, relative date formatting only affects a limited range of calendar days before or after the current date, based on the CLDR <field type="day">/<relative> data: For example, in English, "Yesterday", "Today", and "Tomorrow". Outside of this range, dates are formatted using the corresponding non-relative style. |
locale | The locale specifying the formatting conventions |
tzID | A timezone ID specifying the timezone to use. If 0, use the default timezone. |
tzIDLength | The length of tzID, or -1 if null-terminated. |
pattern | A pattern specifying the format to use. |
patternLength | The number of characters in the pattern, or -1 if null-terminated. |
status | A pointer to an UErrorCode to receive any errors |
UDate udat_parse | ( | const UDateFormat * | format, |
const UChar * | text, | ||
int32_t | textLength, | ||
int32_t * | parsePos, | ||
UErrorCode * | status | ||
) |
Parse a string into an date/time using a UDateFormat.
The date will be parsed using the conventions specified in udat_open.
Note that the normal date formats associated with some calendars - such as the Chinese lunar calendar - do not specify enough fields to enable dates to be parsed unambiguously. In the case of the Chinese lunar calendar, while the year within the current 60-year cycle is specified, the number of such cycles since the start date of the calendar (in the UCAL_ERA field of the UCalendar object) is not normally part of the format, and parsing may assume the wrong era. For cases such as this it is recommended that clients parse using udat_parseCalendar with the UCalendar passed in set to the current date, or to a date within the era/cycle that should be assumed if absent in the format.
format | The formatter to use. |
text | The text to parse. |
textLength | The length of text, or -1 if null-terminated. |
parsePos | If not 0, on input a pointer to an integer specifying the offset at which to begin parsing. If not 0, on output the offset at which parsing ended. |
status | A pointer to an UErrorCode to receive any errors |
void udat_parseCalendar | ( | const UDateFormat * | format, |
UCalendar * | calendar, | ||
const UChar * | text, | ||
int32_t | textLength, | ||
int32_t * | parsePos, | ||
UErrorCode * | status | ||
) |
Parse a string into an date/time using a UDateFormat.
The date will be parsed using the conventions specified in udat_open.
format | The formatter to use. |
calendar | A calendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. When the calendar type is different from the internal calendar held by the UDateFormat instance, the internal calendar will be cloned to a work calendar set to the same milliseconds and time zone as this calendar parameter, field values will be parsed based on the work calendar, then the result (milliseconds and time zone) will be set in this calendar. |
text | The text to parse. |
textLength | The length of text, or -1 if null-terminated. |
parsePos | If not 0, on input a pointer to an integer specifying the offset at which to begin parsing. If not 0, on output the offset at which parsing ended. |
status | A pointer to an UErrorCode to receive any errors |
void udat_registerOpener | ( | UDateFormatOpener | opener, |
UErrorCode * | status | ||
) |
Register a provider factory.
void udat_set2DigitYearStart | ( | UDateFormat * | fmt, |
UDate | d, | ||
UErrorCode * | status | ||
) |
Set the year relative to which all 2-digit years will be interpreted.
For example, if the 2-digit start year is 2100, the year 99 will be interpreted as 2199.
fmt | The formatter to set. |
d | The year relative to which all 2-digit years will be interpreted. |
status | A pointer to an UErrorCode to receive any errors |
void udat_setCalendar | ( | UDateFormat * | fmt, |
const UCalendar * | calendarToSet | ||
) |
Set the UCalendar associated with an UDateFormat.
A UDateFormat uses a UCalendar to convert a raw value to, for example, the day of the week.
fmt | The formatter to set. |
calendarToSet | A pointer to an UCalendar to be used by fmt. |
void udat_setContext | ( | UDateFormat * | fmt, |
UDisplayContext | value, | ||
UErrorCode * | status | ||
) |
Set a particular UDisplayContext value in the formatter, such as UDISPCTX_CAPITALIZATION_FOR_STANDALONE.
fmt | The formatter for which to set a UDisplayContext value. |
value | The UDisplayContext value to set. |
status | A pointer to an UErrorCode to receive any errors |
void udat_setLenient | ( | UDateFormat * | fmt, |
UBool | isLenient | ||
) |
Specify whether an UDateFormat will perform lenient parsing.
With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match the pattern. With strict parsing, inputs must match the pattern.
fmt | The formatter to set |
isLenient | TRUE if fmt should perform lenient parsing, FALSE otherwise. |
void udat_setNumberFormat | ( | UDateFormat * | fmt, |
const UNumberFormat * | numberFormatToSet | ||
) |
Set the UNumberFormat associated with an UDateFormat.
A UDateFormat uses a UNumberFormat to format numbers within a date, for example the day number.
fmt | The formatter to set. |
numberFormatToSet | A pointer to the UNumberFormat to be used by fmt to format numbers. |
void udat_setSymbols | ( | UDateFormat * | format, |
UDateFormatSymbolType | type, | ||
int32_t | symbolIndex, | ||
UChar * | value, | ||
int32_t | valueLength, | ||
UErrorCode * | status | ||
) |
Set the symbols associated with an UDateFormat.
The symbols are what a UDateFormat uses to represent locale-specific data, for example month or day names.
format | The formatter to set |
type | The type of symbols to set. One of UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS, UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, or UDAT_LOCALIZED_CHARS |
symbolIndex | The index of the symbol to set of type type. |
value | The new value |
valueLength | The length of value, or -1 if null-terminated |
status | A pointer to an UErrorCode to receive any errors |
UCalendarDateFields udat_toCalendarDateField | ( | UDateFormatField | field | ) |
Maps from a UDateFormatField to the corresponding UCalendarDateFields.
Note: since the mapping is many-to-one, there is no inverse mapping.
field | the UDateFormatField. |
int32_t udat_toPattern | ( | const UDateFormat * | fmt, |
UBool | localized, | ||
UChar * | result, | ||
int32_t | resultLength, | ||
UErrorCode * | status | ||
) |
Extract the pattern from a UDateFormat.
The pattern will follow the pattern syntax rules.
fmt | The formatter to query. |
localized | TRUE if the pattern should be localized, FALSE otherwise. |
result | A pointer to a buffer to receive the pattern. |
resultLength | The maximum size of result. |
status | A pointer to an UErrorCode to receive any errors |
int32_t udat_toPatternRelativeDate | ( | const UDateFormat * | fmt, |
UChar * | result, | ||
int32_t | resultLength, | ||
UErrorCode * | status | ||
) |
Extract the date pattern from a UDateFormat set for relative date formatting.
The pattern will follow the pattern syntax rules.
fmt | The formatter to query. |
result | A pointer to a buffer to receive the pattern. |
resultLength | The maximum size of result. |
status | A pointer to a UErrorCode to receive any errors |
int32_t udat_toPatternRelativeTime | ( | const UDateFormat * | fmt, |
UChar * | result, | ||
int32_t | resultLength, | ||
UErrorCode * | status | ||
) |
Extract the time pattern from a UDateFormat set for relative date formatting.
The pattern will follow the pattern syntax rules.
fmt | The formatter to query. |
result | A pointer to a buffer to receive the pattern. |
resultLength | The maximum size of result. |
status | A pointer to a UErrorCode to receive any errors |
UDateFormatOpener udat_unregisterOpener | ( | UDateFormatOpener | opener, |
UErrorCode * | status | ||
) |
Un-Register a provider factory.