C API: DateFormat. More...

#include "unicode/utypes.h"
#include "unicode/localpointer.h"
#include "unicode/ucal.h"
#include "unicode/unum.h"
#include "unicode/udisplaycontext.h"

Macros
#define	UDAT_YEAR "y"

#define	UDAT_QUARTER "QQQQ"

#define	UDAT_ABBR_QUARTER "QQQ"

#define	UDAT_YEAR_QUARTER "yQQQQ"

#define	UDAT_YEAR_ABBR_QUARTER "yQQQ"

#define	UDAT_MONTH "MMMM"

#define	UDAT_ABBR_MONTH "MMM"

#define	UDAT_NUM_MONTH "M"

#define	UDAT_YEAR_MONTH "yMMMM"

#define	UDAT_YEAR_ABBR_MONTH "yMMM"

#define	UDAT_YEAR_NUM_MONTH "yM"

#define	UDAT_DAY "d"

#define	UDAT_YEAR_MONTH_DAY "yMMMMd"

#define	UDAT_YEAR_ABBR_MONTH_DAY "yMMMd"

#define	UDAT_YEAR_NUM_MONTH_DAY "yMd"

#define	UDAT_WEEKDAY "EEEE"

#define	UDAT_ABBR_WEEKDAY "E"

#define	UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd"

#define	UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd"

#define	UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd"

#define	UDAT_MONTH_DAY "MMMMd"

#define	UDAT_ABBR_MONTH_DAY "MMMd"

#define	UDAT_NUM_MONTH_DAY "Md"

#define	UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd"

#define	UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd"

#define	UDAT_NUM_MONTH_WEEKDAY_DAY "MEd"

#define	UDAT_HOUR "j"

#define	UDAT_HOUR24 "H"

#define	UDAT_MINUTE "m"

#define	UDAT_HOUR_MINUTE "jm"

#define	UDAT_HOUR24_MINUTE "Hm"

#define	UDAT_SECOND "s"

#define	UDAT_HOUR_MINUTE_SECOND "jms"

#define	UDAT_HOUR24_MINUTE_SECOND "Hms"

#define	UDAT_MINUTE_SECOND "ms"

#define	UDAT_LOCATION_TZ "VVVV"

#define	UDAT_GENERIC_TZ "vvvv"

#define	UDAT_ABBR_GENERIC_TZ "v"

#define	UDAT_SPECIFIC_TZ "zzzz"

#define	UDAT_ABBR_SPECIFIC_TZ "z"

#define	UDAT_ABBR_UTC_TZ "ZZZZ"

#define	UDAT_STANDALONE_MONTH "LLLL"

#define	UDAT_ABBR_STANDALONE_MONTH "LLL"

#define	UDAT_HOUR_MINUTE_GENERIC_TZ "jmv"

#define	UDAT_HOUR_MINUTE_TZ "jmz"

#define	UDAT_HOUR_GENERIC_TZ "jv"

#define	UDAT_HOUR_TZ "jz"

Typedefs
typedef void *	UDateFormat

typedef enum UDateFormatStyle	UDateFormatStyle

typedef enum UDateFormatField	UDateFormatField

typedef enum UDateFormatBooleanAttribute	UDateFormatBooleanAttribute

typedef enum UDateFormatSymbolType	UDateFormatSymbolType

typedef struct UDateFormatSymbols	UDateFormatSymbols

typedef UDateFormat (U_EXPORT2	UDateFormatOpener) (UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char locale, const UChar tzID, int32_t tzIDLength, const UChar pattern, int32_t patternLength, UErrorCode status)

Enumerations
enum	UDateFormatStyle { UDAT_FULL, UDAT_LONG, UDAT_MEDIUM, UDAT_SHORT, UDAT_DEFAULT = UDAT_MEDIUM, UDAT_RELATIVE = (1 << 7), UDAT_FULL_RELATIVE = UDAT_FULL \| UDAT_RELATIVE, UDAT_LONG_RELATIVE = UDAT_LONG \| UDAT_RELATIVE, UDAT_MEDIUM_RELATIVE = UDAT_MEDIUM \| UDAT_RELATIVE, UDAT_SHORT_RELATIVE = UDAT_SHORT \| UDAT_RELATIVE, UDAT_NONE = -1, UDAT_PATTERN = -2, UDAT_IGNORE = UDAT_PATTERN }

enum	UDateFormatField { UDAT_ERA_FIELD = 0, UDAT_YEAR_FIELD = 1, UDAT_MONTH_FIELD = 2, UDAT_DATE_FIELD = 3, UDAT_HOUR_OF_DAY1_FIELD = 4, UDAT_HOUR_OF_DAY0_FIELD = 5, UDAT_MINUTE_FIELD = 6, UDAT_SECOND_FIELD = 7, UDAT_FRACTIONAL_SECOND_FIELD = 8, UDAT_DAY_OF_WEEK_FIELD = 9, UDAT_DAY_OF_YEAR_FIELD = 10, UDAT_DAY_OF_WEEK_IN_MONTH_FIELD = 11, UDAT_WEEK_OF_YEAR_FIELD = 12, UDAT_WEEK_OF_MONTH_FIELD = 13, UDAT_AM_PM_FIELD = 14, UDAT_HOUR1_FIELD = 15, UDAT_HOUR0_FIELD = 16, UDAT_TIMEZONE_FIELD = 17, UDAT_YEAR_WOY_FIELD = 18, UDAT_DOW_LOCAL_FIELD = 19, UDAT_EXTENDED_YEAR_FIELD = 20, UDAT_JULIAN_DAY_FIELD = 21, UDAT_MILLISECONDS_IN_DAY_FIELD = 22, UDAT_TIMEZONE_RFC_FIELD = 23, UDAT_TIMEZONE_GENERIC_FIELD = 24, UDAT_STANDALONE_DAY_FIELD = 25, UDAT_STANDALONE_MONTH_FIELD = 26, UDAT_QUARTER_FIELD = 27, UDAT_STANDALONE_QUARTER_FIELD = 28, UDAT_TIMEZONE_SPECIAL_FIELD = 29, UDAT_YEAR_NAME_FIELD = 30, UDAT_TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD = 31, UDAT_TIMEZONE_ISO_FIELD = 32, UDAT_TIMEZONE_ISO_LOCAL_FIELD = 33, UDAT_FIELD_COUNT = 34 }

enum	UDateFormatBooleanAttribute { UDAT_PARSE_ALLOW_WHITESPACE, UDAT_PARSE_ALLOW_NUMERIC, UDAT_BOOLEAN_ATTRIBUTE_COUNT }

enum	UDateFormatSymbolType { UDAT_ERAS, UDAT_MONTHS, UDAT_SHORT_MONTHS, UDAT_WEEKDAYS, UDAT_SHORT_WEEKDAYS, UDAT_AM_PMS, UDAT_LOCALIZED_CHARS, UDAT_ERA_NAMES, UDAT_NARROW_MONTHS, UDAT_NARROW_WEEKDAYS, UDAT_STANDALONE_MONTHS, UDAT_STANDALONE_SHORT_MONTHS, UDAT_STANDALONE_NARROW_MONTHS, UDAT_STANDALONE_WEEKDAYS, UDAT_STANDALONE_SHORT_WEEKDAYS, UDAT_STANDALONE_NARROW_WEEKDAYS, UDAT_QUARTERS, UDAT_SHORT_QUARTERS, UDAT_STANDALONE_QUARTERS, UDAT_STANDALONE_SHORT_QUARTERS, UDAT_SHORTER_WEEKDAYS, UDAT_STANDALONE_SHORTER_WEEKDAYS }

Functions
U_STABLE UCalendarDateFields U_EXPORT2	udat_toCalendarDateField (UDateFormatField field)

U_STABLE UDateFormat *U_EXPORT2	udat_open (UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char locale, const UChar tzID, int32_t tzIDLength, const UChar pattern, int32_t patternLength, UErrorCode status)

U_STABLE void U_EXPORT2	udat_close (UDateFormat *format)

U_INTERNAL UBool U_EXPORT2	udat_getBooleanAttribute (const UDateFormat fmt, UDateFormatBooleanAttribute attr, UErrorCode status)

U_INTERNAL void U_EXPORT2	udat_setBooleanAttribute (UDateFormat fmt, UDateFormatBooleanAttribute attr, UBool, UErrorCode status)

U_STABLE UDateFormat *U_EXPORT2	udat_clone (const UDateFormat fmt, UErrorCode status)

U_STABLE int32_t U_EXPORT2	udat_format (const UDateFormat format, UDate dateToFormat, UChar result, int32_t resultLength, UFieldPosition position, UErrorCode status)

U_STABLE UDate U_EXPORT2	udat_parse (const UDateFormat format, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode status)

U_STABLE void U_EXPORT2	udat_parseCalendar (const UDateFormat format, UCalendar calendar, const UChar text, int32_t textLength, int32_t parsePos, UErrorCode *status)

U_STABLE UBool U_EXPORT2	udat_isLenient (const UDateFormat *fmt)

U_STABLE void U_EXPORT2	udat_setLenient (UDateFormat *fmt, UBool isLenient)

U_STABLE const UCalendar *U_EXPORT2	udat_getCalendar (const UDateFormat *fmt)

U_STABLE void U_EXPORT2	udat_setCalendar (UDateFormat fmt, const UCalendar calendarToSet)

U_STABLE const UNumberFormat *U_EXPORT2	udat_getNumberFormat (const UDateFormat *fmt)

U_STABLE void U_EXPORT2	udat_setNumberFormat (UDateFormat fmt, const UNumberFormat numberFormatToSet)

U_STABLE const char *U_EXPORT2	udat_getAvailable (int32_t localeIndex)

U_STABLE int32_t U_EXPORT2	udat_countAvailable (void)

U_STABLE UDate U_EXPORT2	udat_get2DigitYearStart (const UDateFormat fmt, UErrorCode status)

U_STABLE void U_EXPORT2	udat_set2DigitYearStart (UDateFormat fmt, UDate d, UErrorCode status)

U_STABLE int32_t U_EXPORT2	udat_toPattern (const UDateFormat fmt, UBool localized, UChar result, int32_t resultLength, UErrorCode *status)

U_STABLE void U_EXPORT2	udat_applyPattern (UDateFormat format, UBool localized, const UChar pattern, int32_t patternLength)

U_STABLE int32_t U_EXPORT2	udat_getSymbols (const UDateFormat fmt, UDateFormatSymbolType type, int32_t symbolIndex, UChar result, int32_t resultLength, UErrorCode *status)

U_STABLE int32_t U_EXPORT2	udat_countSymbols (const UDateFormat *fmt, UDateFormatSymbolType type)

U_STABLE void U_EXPORT2	udat_setSymbols (UDateFormat format, UDateFormatSymbolType type, int32_t symbolIndex, UChar value, int32_t valueLength, UErrorCode *status)

U_STABLE const char *U_EXPORT2	udat_getLocaleByType (const UDateFormat fmt, ULocDataLocaleType type, UErrorCode status)

U_DRAFT void U_EXPORT2	udat_setContext (UDateFormat fmt, UDisplayContext value, UErrorCode status)

U_DRAFT UDisplayContext U_EXPORT2	udat_getContext (UDateFormat fmt, UDisplayContextType type, UErrorCode status)

U_INTERNAL int32_t U_EXPORT2	udat_toPatternRelativeDate (const UDateFormat fmt, UChar result, int32_t resultLength, UErrorCode *status)

U_INTERNAL int32_t U_EXPORT2	udat_toPatternRelativeTime (const UDateFormat fmt, UChar result, int32_t resultLength, UErrorCode *status)

U_INTERNAL void U_EXPORT2	udat_applyPatternRelative (UDateFormat format, const UChar datePattern, int32_t datePatternLength, const UChar timePattern, int32_t timePatternLength, UErrorCode status)

U_INTERNAL void U_EXPORT2	udat_registerOpener (UDateFormatOpener opener, UErrorCode *status)

U_INTERNAL UDateFormatOpener U_EXPORT2	udat_unregisterOpener (UDateFormatOpener opener, UErrorCode *status)

Detailed Description

C API: DateFormat.

Date Format C API

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;
UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, -1, &status);
myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, NULL, &status);
if (status==U_BUFFER_OVERFLOW_ERROR){
    status=U_ZERO_ERROR;
    myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
    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
UDateFormat* df = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, NULL, -1, NULL, 0, &status);
for (i = 0; i < 3; i++) {
    myStrlen = udat_format(df, myDateArr[i], NULL, myStrlen, NULL, &status);
    if(status == U_BUFFER_OVERFLOW_ERROR){
        status = U_ZERO_ERROR;
        myString = (UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
        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
UDateFormat* dfmt = udat_open(UDAT_DEFAULT, UDAT_DEFAULT, NULL, -1, NULL, 0, &status);
myStrlen = udat_format(dfmt, myDate, NULL, myStrlen, &pos, &status);
if (status==U_BUFFER_OVERFLOW_ERROR){
    status=U_ZERO_ERROR;
    myString=(UChar*)malloc(sizeof(UChar) * (myStrlen+1) );
    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()

UDateFormat* df = udat_open(UDAT_SHORT, UDAT_SHORT, "fr_FR", NULL, -1, NULL, 0, &status);

You can use a DateFormat API udat_parse() to parse.

UErrorCode status = U_ZERO_ERROR;
int32_t parsepos=0;
UDate myDate = udat_parse(df, myString, u_strlen(myString), &parsepos, &status);

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

UDAT_SHORT is completely numeric, such as 12/13/52 or 3:30pm
UDAT_MEDIUM is longer, such as Jan 12, 1952
UDAT_LONG is longer, such as January 12, 1952 or 3:30:32pm
UDAT_FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42pm PST.

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

Progressively parse through pieces of a string.
Align any particular field, or find out where it is for selection on the screen.

Date and Time Patterns:

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, all unquoted ASCII letters [A-Za-z] are reserved as pattern letters representing calendar fields. UDateFormat supports the date and time formatting algorithm and pattern letters defined by UTS#35 Unicode Locale Data Markup Language (LDML) and further documented for ICU in the ICU User Guide.

Macro Definition Documentation

◆ UDAT_ABBR_GENERIC_TZ

#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.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_ABBR_MONTH

#define UDAT_ABBR_MONTH "MMM"

Constant for date skeleton with abbreviated month. ICU 4.0

◆ UDAT_ABBR_MONTH_DAY

#define UDAT_ABBR_MONTH_DAY "MMMd"

Constant for date skeleton with abbreviated month and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_ABBR_MONTH_WEEKDAY_DAY

#define UDAT_ABBR_MONTH_WEEKDAY_DAY "MMMEd"

Constant for date skeleton with abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_ABBR_QUARTER

#define UDAT_ABBR_QUARTER "QQQ"

Constant for date skeleton with abbreviated quarter. ICU 51

◆ UDAT_ABBR_SPECIFIC_TZ

#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.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_ABBR_STANDALONE_MONTH

#define UDAT_ABBR_STANDALONE_MONTH "LLL"

Constant for date skeleton with standalone abbreviated month.

Deprecated:: ICU 50 Use UDAT_ABBR_MONTH instead.

◆ UDAT_ABBR_UTC_TZ

#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.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_ABBR_WEEKDAY

#define UDAT_ABBR_WEEKDAY "E"

Constant for date skeleton with abbreviated weekday. ICU 51

◆ UDAT_DAY

#define UDAT_DAY "d"

Constant for date skeleton with day. ICU 4.0

◆ UDAT_GENERIC_TZ

#define UDAT_GENERIC_TZ "vvvv"

Constant for generic non-location format, such as Pacific Time; used in combinations date + time + zone, or time + zone.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_HOUR

#define UDAT_HOUR "j"

Constant for date skeleton with hour, with the locale's preferred hour format (12 or 24). ICU 4.0

◆ UDAT_HOUR24

#define UDAT_HOUR24 "H"

Constant for date skeleton with hour in 24-hour presentation. ICU 51

◆ UDAT_HOUR24_MINUTE

#define UDAT_HOUR24_MINUTE "Hm"

Constant for date skeleton with hour and minute in 24-hour presentation. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_HOUR24_MINUTE_SECOND

#define UDAT_HOUR24_MINUTE_SECOND "Hms"

Constant for date skeleton with hour, minute, and second in 24-hour presentation. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_HOUR_GENERIC_TZ

#define UDAT_HOUR_GENERIC_TZ "jv"

Constant for date skeleton with hour and generic timezone.

Deprecated:: ICU 50 Use instead UDAT_HOUR UDAT_ABBR_GENERIC_TZ or some other timezone presentation.

◆ UDAT_HOUR_MINUTE

#define UDAT_HOUR_MINUTE "jm"

Constant for date skeleton with hour and minute, with the locale's preferred hour format (12 or 24). Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_HOUR_MINUTE_GENERIC_TZ

#define UDAT_HOUR_MINUTE_GENERIC_TZ "jmv"

Constant for date skeleton with hour, minute, and generic timezone.

Deprecated:: ICU 50 Use instead UDAT_HOUR_MINUTE UDAT_ABBR_GENERIC_TZ or some other timezone presentation.

◆ UDAT_HOUR_MINUTE_SECOND

#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). Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_HOUR_MINUTE_TZ

#define UDAT_HOUR_MINUTE_TZ "jmz"

Constant for date skeleton with hour, minute, and timezone.

Deprecated:: ICU 50 Use instead UDAT_HOUR_MINUTE UDAT_ABBR_SPECIFIC_TZ or some other timezone presentation.

◆ UDAT_HOUR_TZ

#define UDAT_HOUR_TZ "jz"

Constant for date skeleton with hour and timezone.

Deprecated:: ICU 50 Use instead UDAT_HOUR UDAT_ABBR_SPECIFIC_TZ or some other timezone presentation.

◆ UDAT_LOCATION_TZ

#define UDAT_LOCATION_TZ "VVVV"

Constant for generic location format, such as Los Angeles Time; used in combinations date + time + zone, or time + zone.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_MINUTE

#define UDAT_MINUTE "m"

Constant for date skeleton with minute. ICU 51

◆ UDAT_MINUTE_SECOND

#define UDAT_MINUTE_SECOND "ms"

Constant for date skeleton with minute and second. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_MONTH

#define UDAT_MONTH "MMMM"

Constant for date skeleton with month. ICU 4.0

◆ UDAT_MONTH_DAY

#define UDAT_MONTH_DAY "MMMMd"

Constant for date skeleton with long month and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_MONTH_WEEKDAY_DAY

#define UDAT_MONTH_WEEKDAY_DAY "MMMMEEEEd"

Constant for date skeleton with month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_NUM_MONTH

#define UDAT_NUM_MONTH "M"

Constant for date skeleton with numeric month. ICU 4.0

◆ UDAT_NUM_MONTH_DAY

#define UDAT_NUM_MONTH_DAY "Md"

Constant for date skeleton with numeric month and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_NUM_MONTH_WEEKDAY_DAY

#define UDAT_NUM_MONTH_WEEKDAY_DAY "MEd"

Constant for date skeleton with numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_QUARTER

#define UDAT_QUARTER "QQQQ"

Constant for date skeleton with quarter. ICU 51

◆ UDAT_SECOND

#define UDAT_SECOND "s"

Constant for date skeleton with second. ICU 51

◆ UDAT_SPECIFIC_TZ

#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.

See also: LDML Date Format Patterns; LDML Time Zone Fallback ICU 51

◆ UDAT_STANDALONE_MONTH

#define UDAT_STANDALONE_MONTH "LLLL"

Constant for date skeleton with standalone month.

Deprecated:: ICU 50 Use UDAT_MONTH instead.

◆ UDAT_WEEKDAY

#define UDAT_WEEKDAY "EEEE"

Constant for date skeleton with weekday. ICU 51

◆ UDAT_YEAR

#define UDAT_YEAR "y"

Constant for date skeleton with year. ICU 4.0

◆ UDAT_YEAR_ABBR_MONTH

#define UDAT_YEAR_ABBR_MONTH "yMMM"

Constant for date skeleton with year and abbreviated month. ICU 4.0

◆ UDAT_YEAR_ABBR_MONTH_DAY

#define UDAT_YEAR_ABBR_MONTH_DAY "yMMMd"

Constant for date skeleton with year, abbreviated month, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY

#define UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY "yMMMEd"

Constant for date skeleton with year, abbreviated month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_ABBR_QUARTER

#define UDAT_YEAR_ABBR_QUARTER "yQQQ"

Constant for date skeleton with year and abbreviated quarter. ICU 4.0

◆ UDAT_YEAR_MONTH

#define UDAT_YEAR_MONTH "yMMMM"

Constant for date skeleton with year and month. ICU 4.0

◆ UDAT_YEAR_MONTH_DAY

#define UDAT_YEAR_MONTH_DAY "yMMMMd"

Constant for date skeleton with year, month, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_MONTH_WEEKDAY_DAY

#define UDAT_YEAR_MONTH_WEEKDAY_DAY "yMMMMEEEEd"

Constant for date skeleton with year, month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_NUM_MONTH

#define UDAT_YEAR_NUM_MONTH "yM"

Constant for date skeleton with year and numeric month. ICU 4.0

◆ UDAT_YEAR_NUM_MONTH_DAY

#define UDAT_YEAR_NUM_MONTH_DAY "yMd"

Constant for date skeleton with year, numeric month, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY

#define UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY "yMEd"

Constant for date skeleton with year, numeric month, weekday, and day. Used in combinations date + time, date + time + zone, or time + zone. ICU 4.0

◆ UDAT_YEAR_QUARTER

#define UDAT_YEAR_QUARTER "yQQQQ"

Constant for date skeleton with year and quarter. ICU 4.0

Typedef Documentation

◆ UDateFormat

typedef void* UDateFormat

A date formatter. For usage in C programs. ICU 2.6

◆ UDateFormatBooleanAttribute

typedef enum UDateFormatBooleanAttribute UDateFormatBooleanAttribute

DateFormat boolean attributes

◆ UDateFormatField

typedef enum UDateFormatField UDateFormatField

FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat. ICU 3.0

◆ UDateFormatOpener

typedef UDateFormat*(U_EXPORT2 * UDateFormatOpener) (UDateFormatStyle timeStyle, UDateFormatStyle dateStyle, const char *locale, const UChar *tzID, int32_t tzIDLength, const UChar *pattern, int32_t patternLength, UErrorCode *status)

◆ UDateFormatStyle

typedef enum UDateFormatStyle UDateFormatStyle

The possible date/time format styles ICU 2.6

◆ UDateFormatSymbols

typedef struct UDateFormatSymbols UDateFormatSymbols

Date format symbols. For usage in C programs. ICU 2.6

◆ UDateFormatSymbolType

typedef enum UDateFormatSymbolType UDateFormatSymbolType

The possible types of date format symbols ICU 2.6

Enumeration Type Documentation

◆ UDateFormatBooleanAttribute

enum UDateFormatBooleanAttribute

DateFormat boolean attributes

Enumerator
UDAT_PARSE_ALLOW_WHITESPACE	indicates whether whitespace is allowed. Includes trailing dot tolerance.
UDAT_PARSE_ALLOW_NUMERIC	indicates tolerance of numeric data when String data may be assumed. eg: UDAT_YEAR_NAME_FIELD, UDAT_STANDALONE_MONTH_FIELD, UDAT_DAY_OF_WEEK_FIELD
UDAT_BOOLEAN_ATTRIBUTE_COUNT	count boolean date format constants

◆ UDateFormatField

enum UDateFormatField

FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat. ICU 3.0

Enumerator
UDAT_ERA_FIELD	FieldPosition and UFieldPosition selector for 'G' field alignment, corresponding to the UCAL_ERA field. ICU 3.0
UDAT_YEAR_FIELD	FieldPosition and UFieldPosition selector for 'y' field alignment, corresponding to the UCAL_YEAR field. ICU 3.0
UDAT_MONTH_FIELD	FieldPosition and UFieldPosition selector for 'M' field alignment, corresponding to the UCAL_MONTH field. ICU 3.0
UDAT_DATE_FIELD	FieldPosition and UFieldPosition selector for 'd' field alignment, corresponding to the UCAL_DATE field. ICU 3.0
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. ICU 3.0
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. ICU 3.0
UDAT_MINUTE_FIELD	FieldPosition and UFieldPosition selector for 'm' field alignment, corresponding to the UCAL_MINUTE field. ICU 3.0
UDAT_SECOND_FIELD	FieldPosition and UFieldPosition selector for 's' field alignment, corresponding to the UCAL_SECOND field. ICU 3.0
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. ICU 3.0
UDAT_DAY_OF_WEEK_FIELD	FieldPosition and UFieldPosition selector for 'E' field alignment, corresponding to the UCAL_DAY_OF_WEEK field. ICU 3.0
UDAT_DAY_OF_YEAR_FIELD	FieldPosition and UFieldPosition selector for 'D' field alignment, corresponding to the UCAL_DAY_OF_YEAR field. ICU 3.0
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. ICU 3.0
UDAT_WEEK_OF_YEAR_FIELD	FieldPosition and UFieldPosition selector for 'w' field alignment, corresponding to the UCAL_WEEK_OF_YEAR field. ICU 3.0
UDAT_WEEK_OF_MONTH_FIELD	FieldPosition and UFieldPosition selector for 'W' field alignment, corresponding to the UCAL_WEEK_OF_MONTH field. ICU 3.0
UDAT_AM_PM_FIELD	FieldPosition and UFieldPosition selector for 'a' field alignment, corresponding to the UCAL_AM_PM field. ICU 3.0
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. ICU 3.0
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. ICU 3.0
UDAT_TIMEZONE_FIELD	FieldPosition and UFieldPosition selector for 'z' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSET fields. ICU 3.0
UDAT_YEAR_WOY_FIELD	FieldPosition and UFieldPosition selector for 'Y' field alignment, corresponding to the UCAL_YEAR_WOY field. ICU 3.0
UDAT_DOW_LOCAL_FIELD	FieldPosition and UFieldPosition selector for 'e' field alignment, corresponding to the UCAL_DOW_LOCAL field. ICU 3.0
UDAT_EXTENDED_YEAR_FIELD	FieldPosition and UFieldPosition selector for 'u' field alignment, corresponding to the UCAL_EXTENDED_YEAR field. ICU 3.0
UDAT_JULIAN_DAY_FIELD	FieldPosition and UFieldPosition selector for 'g' field alignment, corresponding to the UCAL_JULIAN_DAY field. ICU 3.0
UDAT_MILLISECONDS_IN_DAY_FIELD	FieldPosition and UFieldPosition selector for 'A' field alignment, corresponding to the UCAL_MILLISECONDS_IN_DAY field. ICU 3.0
UDAT_TIMEZONE_RFC_FIELD	FieldPosition and UFieldPosition selector for 'Z' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSET fields. ICU 3.0
UDAT_TIMEZONE_GENERIC_FIELD	FieldPosition and UFieldPosition selector for 'v' field alignment, corresponding to the UCAL_ZONE_OFFSET field. ICU 3.4
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. ICU 3.4
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. ICU 3.4
UDAT_QUARTER_FIELD	FieldPosition selector for "Q" field alignment, corresponding to quarters. This is implemented using the UCAL_MONTH field. This displays the quarter. ICU 3.6
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. ICU 3.6
UDAT_TIMEZONE_SPECIAL_FIELD	FieldPosition and UFieldPosition selector for 'V' field alignment, corresponding to the UCAL_ZONE_OFFSET field. ICU 3.8
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. ICU 49
UDAT_TIMEZONE_LOCALIZED_GMT_OFFSET_FIELD	FieldPosition selector for 'O' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSETfields. This displays the localized GMT format. ICU 51
UDAT_TIMEZONE_ISO_FIELD	FieldPosition selector for 'X' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSETfields. This displays the ISO 8601 local time offset format or UTC indicator ("Z"). ICU 51
UDAT_TIMEZONE_ISO_LOCAL_FIELD	FieldPosition selector for 'x' field alignment, corresponding to the UCAL_ZONE_OFFSET and UCAL_DST_OFFSETfields. This displays the ISO 8601 local time offset format. ICU 51
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. ICU 3.0

◆ UDateFormatStyle

enum UDateFormatStyle

The possible date/time format styles ICU 2.6

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_FULL_RELATIVE
UDAT_LONG_RELATIVE
UDAT_MEDIUM_RELATIVE
UDAT_SHORT_RELATIVE
UDAT_NONE	No style
UDAT_PATTERN	Use the pattern given in the parameter to udat_open See also udat_open ICU 50
UDAT_IGNORE

◆ UDateFormatSymbolType

enum UDateFormatSymbolType

The possible types of date format symbols ICU 2.6

Enumerator
UDAT_ERAS	The era names, for example AD
UDAT_MONTHS	The month names, for example February
UDAT_SHORT_MONTHS	The short month names, for example Feb.
UDAT_WEEKDAYS	The CLDR-style format "wide" weekday names, for example Monday
UDAT_SHORT_WEEKDAYS	The CLDR-style format "abbreviated" (not "short") weekday names, for example "Mon." For the CLDR-style format "short" weekday names, use UDAT_SHORTER_WEEKDAYS.
UDAT_AM_PMS	The AM/PM names, for example AM
UDAT_LOCALIZED_CHARS	The localized characters
UDAT_ERA_NAMES	The long era names, for example Anno Domini
UDAT_NARROW_MONTHS	The narrow month names, for example F
UDAT_NARROW_WEEKDAYS	The CLDR-style format "narrow" weekday names, for example "M"
UDAT_STANDALONE_MONTHS	Standalone context versions of months
UDAT_STANDALONE_SHORT_MONTHS
UDAT_STANDALONE_NARROW_MONTHS
UDAT_STANDALONE_WEEKDAYS	The CLDR-style stand-alone "wide" weekday names
UDAT_STANDALONE_SHORT_WEEKDAYS	The CLDR-style stand-alone "abbreviated" (not "short") weekday names. For the CLDR-style stand-alone "short" weekday names, use UDAT_STANDALONE_SHORTER_WEEKDAYS.
UDAT_STANDALONE_NARROW_WEEKDAYS	The CLDR-style stand-alone "narrow" weekday names
UDAT_QUARTERS	The quarters, for example 1st Quarter
UDAT_SHORT_QUARTERS	The short quarter names, for example Q1
UDAT_STANDALONE_QUARTERS	Standalone context versions of quarters
UDAT_STANDALONE_SHORT_QUARTERS
UDAT_SHORTER_WEEKDAYS	The CLDR-style short weekday names, e.g. "Su", Mo", etc. These are named "SHORTER" to contrast with the constants using SHORT above, which actually get the CLDR-style abbreviated versions of the corresponding names. ICU 51
UDAT_STANDALONE_SHORTER_WEEKDAYS	Standalone version of UDAT_SHORTER_WEEKDAYS. ICU 51

Function Documentation

◆ udat_applyPattern()

U_STABLE void U_EXPORT2 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.

Parameters

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.

See also: udat_toPattern ICU 2.0

◆ udat_applyPatternRelative()

U_INTERNAL void U_EXPORT2 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.

Parameters

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

See also: udat_toPatternRelativeDate, udat_toPatternRelativeTime

◆ udat_clone()

U_STABLE UDateFormat* U_EXPORT2 udat_clone	(	const UDateFormat *	fmt,
		UErrorCode *	status
	)

Open a copy of a UDateFormat. This function performs a deep copy.

Parameters

fmt	The format to copy
status	A pointer to an UErrorCode to receive any errors.

Returns: A pointer to a UDateFormat identical to fmt. ICU 2.0

◆ udat_close()

U_STABLE void U_EXPORT2 udat_close ( UDateFormat * format )

Close a UDateFormat. Once closed, a UDateFormat may no longer be used.

Parameters

format The formatter to close. ICU 2.0

◆ udat_countAvailable()

U_STABLE int32_t U_EXPORT2 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.

Returns: The number of locales for which date/time formatting patterns are available.

See also: udat_getAvailable ICU 2.0

◆ udat_countSymbols()

U_STABLE int32_t U_EXPORT2 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.

Parameters

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

Returns: The number of symbols of type type.

See also: udat_getSymbols; udat_setSymbols ICU 2.0

◆ udat_format()

U_STABLE int32_t U_EXPORT2 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

Parameters

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

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: udat_parse; UFieldPosition ICU 2.0

◆ udat_get2DigitYearStart()

U_STABLE UDate U_EXPORT2 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.

Parameters

fmt	The formatter to query.
status	A pointer to an UErrorCode to receive any errors

Returns: The year relative to which all 2-digit years are interpreted.

See also: udat_Set2DigitYearStart ICU 2.0

◆ udat_getAvailable()

U_STABLE const char* U_EXPORT2 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.

Parameters

localeIndex The index of the desired locale.

Returns: A locale for which date/time formatting patterns are available, or 0 if none.

See also: udat_countAvailable ICU 2.0

◆ udat_getBooleanAttribute()

U_INTERNAL UBool U_EXPORT2 udat_getBooleanAttribute	(	const UDateFormat *	fmt,
		UDateFormatBooleanAttribute	attr,
		UErrorCode *	status
	)

Get a boolean attribute associated with a UDateFormat. An example would be a true value for a key of UDAT_PARSE_ALLOW_WHITESPACE indicating allowing whitespace leniency. If the formatter does not understand the attribute, -1 is returned.

Parameters

fmt	The formatter to query.
attr	The attribute to query; e.g. UDAT_PARSE_ALLOW_WHITESPACE.
status	A pointer to an UErrorCode to receive any errors

Returns: The value of attr.

◆ udat_getCalendar()

U_STABLE const UCalendar* U_EXPORT2 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.

Parameters

fmt	The formatter to query.

Returns: A pointer to the UCalendar used by fmt.

See also: udat_setCalendar ICU 2.0

◆ udat_getContext()

U_DRAFT UDisplayContext U_EXPORT2 udat_getContext	(	UDateFormat *	fmt,
		UDisplayContextType	type,
		UErrorCode *	status
	)

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

Parameters

fmt	The formatter to query.
type	The UDisplayContextType whose value to return
status	A pointer to an UErrorCode to receive any errors

Returns: The UDisplayContextValue for the specified type. ICU 51

◆ udat_getLocaleByType()

U_STABLE const char* U_EXPORT2 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.

Parameters

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

Returns: the locale name ICU 2.8

◆ udat_getNumberFormat()

U_STABLE const UNumberFormat* U_EXPORT2 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.

Parameters

fmt	The formatter to query.

Returns: A pointer to the UNumberFormat used by fmt to format numbers.

See also: udat_setNumberFormat ICU 2.0

◆ udat_getSymbols()

U_STABLE int32_t U_EXPORT2 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.

Parameters

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

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: udat_countSymbols; udat_setSymbols ICU 2.0

◆ udat_isLenient()

U_STABLE UBool U_EXPORT2 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.

Parameters

fmt	The formatter to query

Returns: TRUE if fmt is set to perform lenient parsing, FALSE otherwise.

See also: udat_setLenient ICU 2.0

◆ udat_open()

U_STABLE UDateFormat* U_EXPORT2 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.

Parameters

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

Returns: A pointer to a UDateFormat to use for formatting dates and times, or 0 if an error occurred. ICU 2.0

◆ udat_parse()

U_STABLE UDate U_EXPORT2 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.

Parameters

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

Returns: The value of the parsed date/time

See also: udat_format ICU 2.0

◆ udat_parseCalendar()

U_STABLE void U_EXPORT2 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.

Parameters

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

See also: udat_format ICU 2.0

◆ udat_registerOpener()

U_INTERNAL void U_EXPORT2 udat_registerOpener	(	UDateFormatOpener	opener,
		UErrorCode *	status
	)

Register a provider factory

◆ udat_set2DigitYearStart()

U_STABLE void U_EXPORT2 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.

Parameters

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

See also: udat_Set2DigitYearStart ICU 2.0

◆ udat_setBooleanAttribute()

U_INTERNAL void U_EXPORT2 udat_setBooleanAttribute	(	UDateFormat *	fmt,
		UDateFormatBooleanAttribute	attr,
		UBool	,
		UErrorCode *	status
	)

Set a boolean attribute associated with a UDateFormat. An example of a boolean attribute is parse leniency control. If the formatter does not understand the attribute, the call is ignored.

Parameters

fmt	The formatter to set.
attr	The attribute to set; one of UDAT_PARSE_ALLOW_WHITESPACE or UDAT_PARSE_ALLOW_NUMERIC
newValue	The new value of attr.
status	A pointer to an UErrorCode to receive any errors

◆ udat_setCalendar()

U_STABLE void U_EXPORT2 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.

Parameters

fmt	The formatter to set.
calendarToSet	A pointer to an UCalendar to be used by fmt.

See also: udat_setCalendar ICU 2.0

◆ udat_setContext()

U_DRAFT void U_EXPORT2 udat_setContext	(	UDateFormat *	fmt,
		UDisplayContext	value,
		UErrorCode *	status
	)

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

Parameters

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 ICU 51

◆ udat_setLenient()

U_STABLE void U_EXPORT2 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.

Parameters

fmt	The formatter to set
isLenient	TRUE if fmt should perform lenient parsing, FALSE otherwise.

See also: dat_isLenient ICU 2.0

◆ udat_setNumberFormat()

U_STABLE void U_EXPORT2 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.

Parameters

fmt	The formatter to set.
numberFormatToSet	A pointer to the UNumberFormat to be used by fmt to format numbers.

See also: udat_getNumberFormat ICU 2.0

◆ udat_setSymbols()

U_STABLE void U_EXPORT2 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.

Parameters

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

See also: udat_getSymbols; udat_countSymbols ICU 2.0

◆ udat_toCalendarDateField()

U_STABLE UCalendarDateFields U_EXPORT2 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.

Parameters

field the UDateFormatField.

Returns: the UCalendarDateField. This will be UCAL_FIELD_COUNT in case of error (e.g., the input field is UDAT_FIELD_COUNT). ICU 4.4

◆ udat_toPattern()

U_STABLE int32_t U_EXPORT2 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.

Parameters

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

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: udat_applyPattern ICU 2.0

◆ udat_toPatternRelativeDate()

U_INTERNAL int32_t U_EXPORT2 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.

Parameters

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

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: udat_applyPatternRelative

◆ udat_toPatternRelativeTime()

U_INTERNAL int32_t U_EXPORT2 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.

Parameters

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

Returns: The total buffer size needed; if greater than resultLength, the output was truncated.

See also: udat_applyPatternRelative

◆ udat_unregisterOpener()

U_INTERNAL UDateFormatOpener U_EXPORT2 udat_unregisterOpener	(	UDateFormatOpener	opener,
		UErrorCode *	status
	)

Un-Register a provider factory

Macros

Typedefs

Enumerations

Functions

Detailed Description

Date Format C API

Macro Definition Documentation

◆ UDAT_ABBR_GENERIC_TZ

◆ UDAT_ABBR_MONTH

◆ UDAT_ABBR_MONTH_DAY

◆ UDAT_ABBR_MONTH_WEEKDAY_DAY

◆ UDAT_ABBR_QUARTER

◆ UDAT_ABBR_SPECIFIC_TZ

◆ UDAT_ABBR_STANDALONE_MONTH

◆ UDAT_ABBR_UTC_TZ

◆ UDAT_ABBR_WEEKDAY

◆ UDAT_DAY

◆ UDAT_GENERIC_TZ

◆ UDAT_HOUR

◆ UDAT_HOUR24

◆ UDAT_HOUR24_MINUTE

◆ UDAT_HOUR24_MINUTE_SECOND

◆ UDAT_HOUR_GENERIC_TZ

◆ UDAT_HOUR_MINUTE

◆ UDAT_HOUR_MINUTE_GENERIC_TZ

◆ UDAT_HOUR_MINUTE_SECOND

◆ UDAT_HOUR_MINUTE_TZ

◆ UDAT_HOUR_TZ

◆ UDAT_LOCATION_TZ

◆ UDAT_MINUTE

◆ UDAT_MINUTE_SECOND

◆ UDAT_MONTH

◆ UDAT_MONTH_DAY

◆ UDAT_MONTH_WEEKDAY_DAY

◆ UDAT_NUM_MONTH

◆ UDAT_NUM_MONTH_DAY

◆ UDAT_NUM_MONTH_WEEKDAY_DAY

◆ UDAT_QUARTER

◆ UDAT_SECOND

◆ UDAT_SPECIFIC_TZ

◆ UDAT_STANDALONE_MONTH

◆ UDAT_WEEKDAY

◆ UDAT_YEAR

◆ UDAT_YEAR_ABBR_MONTH

◆ UDAT_YEAR_ABBR_MONTH_DAY

◆ UDAT_YEAR_ABBR_MONTH_WEEKDAY_DAY

◆ UDAT_YEAR_ABBR_QUARTER

◆ UDAT_YEAR_MONTH

◆ UDAT_YEAR_MONTH_DAY

◆ UDAT_YEAR_MONTH_WEEKDAY_DAY

◆ UDAT_YEAR_NUM_MONTH

◆ UDAT_YEAR_NUM_MONTH_DAY

◆ UDAT_YEAR_NUM_MONTH_WEEKDAY_DAY

◆ UDAT_YEAR_QUARTER

Typedef Documentation

◆ UDateFormat

◆ UDateFormatBooleanAttribute

◆ UDateFormatField

◆ UDateFormatOpener

◆ UDateFormatStyle

◆ UDateFormatSymbols

◆ UDateFormatSymbolType

Enumeration Type Documentation

◆ UDateFormatBooleanAttribute

◆ UDateFormatField

◆ UDateFormatStyle

◆ UDateFormatSymbolType

Function Documentation

◆ udat_applyPattern()

◆ udat_applyPatternRelative()

◆ udat_clone()

◆ udat_close()

◆ udat_countAvailable()

◆ udat_countSymbols()

◆ udat_format()

◆ udat_get2DigitYearStart()

◆ udat_getAvailable()

◆ udat_getBooleanAttribute()

◆ udat_getCalendar()

◆ udat_getContext()