ucal.h File Reference

C API: Calendar. More...

#include "unicode/utypes.h"
#include "unicode/uenum.h"
#include "unicode/uloc.h"
#include "unicode/localpointer.h"

Go to the source code of this file.

Typedefs

typedef void * UCalendar
 A calendar.
typedef enum UCalendarType UCalendarType
typedef enum UCalendarDateFields UCalendarDateFields
typedef enum UCalendarDaysOfWeek UCalendarDaysOfWeek
typedef enum UCalendarMonths UCalendarMonths
typedef enum UCalendarAMPMs UCalendarAMPMs
typedef enum
UCalendarDisplayNameType 
UCalendarDisplayNameType
typedef enum UCalendarAttribute UCalendarAttribute
typedef enum UCalendarLimitType UCalendarLimitType
typedef enum UCalendarWeekdayType UCalendarWeekdayType

Enumerations

enum  UCalendarType { UCAL_TRADITIONAL, UCAL_DEFAULT = UCAL_TRADITIONAL, UCAL_GREGORIAN }
 

Possible types of UCalendars.

More...
enum  UCalendarDateFields {
  UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR,
  UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK,
  UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY,
  UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET,
  UCAL_DST_OFFSET, UCAL_YEAR_WOY, UCAL_DOW_LOCAL, UCAL_EXTENDED_YEAR,
  UCAL_JULIAN_DAY, UCAL_MILLISECONDS_IN_DAY, UCAL_IS_LEAP_MONTH, UCAL_FIELD_COUNT,
  UCAL_DAY_OF_MONTH = UCAL_DATE
}
 

Possible fields in a UCalendar.

More...
enum  UCalendarDaysOfWeek {
  UCAL_SUNDAY = 1, UCAL_MONDAY, UCAL_TUESDAY, UCAL_WEDNESDAY,
  UCAL_THURSDAY, UCAL_FRIDAY, UCAL_SATURDAY
}
 

Useful constant for days of week.

More...
enum  UCalendarMonths {
  UCAL_JANUARY, UCAL_FEBRUARY, UCAL_MARCH, UCAL_APRIL,
  UCAL_MAY, UCAL_JUNE, UCAL_JULY, UCAL_AUGUST,
  UCAL_SEPTEMBER, UCAL_OCTOBER, UCAL_NOVEMBER, UCAL_DECEMBER,
  UCAL_UNDECIMBER
}
 

Possible months in a UCalendar.

More...
enum  UCalendarAMPMs { UCAL_AM, UCAL_PM }
 

Possible AM/PM values in a UCalendar.

More...
enum  UCalendarDisplayNameType { UCAL_STANDARD, UCAL_SHORT_STANDARD, UCAL_DST, UCAL_SHORT_DST }
 

Possible formats for a UCalendar's display name.

More...
enum  UCalendarAttribute { UCAL_LENIENT, UCAL_FIRST_DAY_OF_WEEK, UCAL_MINIMAL_DAYS_IN_FIRST_WEEK }
 

Types of UCalendar attributes.

More...
enum  UCalendarLimitType {
  UCAL_MINIMUM, UCAL_MAXIMUM, UCAL_GREATEST_MINIMUM, UCAL_LEAST_MAXIMUM,
  UCAL_ACTUAL_MINIMUM, UCAL_ACTUAL_MAXIMUM
}
 

Possible limit values for a UCalendar.

More...
enum  UCalendarWeekdayType { UCAL_WEEKDAY, UCAL_WEEKEND, UCAL_WEEKEND_ONSET, UCAL_WEEKEND_CEASE }
 

Weekday types, as returned by ucal_getDayOfWeekType().

More...

Functions

UEnumerationucal_openTimeZones (UErrorCode *ec)
 Create an enumeration over all time zones.
UEnumerationucal_openCountryTimeZones (const char *country, UErrorCode *ec)
 Create an enumeration over all time zones associated with the given country.
int32_t ucal_getDefaultTimeZone (UChar *result, int32_t resultCapacity, UErrorCode *ec)
 Return the default time zone.
void ucal_setDefaultTimeZone (const UChar *zoneID, UErrorCode *ec)
 Set the default time zone.
int32_t ucal_getDSTSavings (const UChar *zoneID, UErrorCode *ec)
 Return the amount of time in milliseconds that the clock is advanced during daylight savings time for the given time zone, or zero if the time zone does not observe daylight savings time.
UDate ucal_getNow (void)
 Get the current date and time.
UCalendarucal_open (const UChar *zoneID, int32_t len, const char *locale, UCalendarType type, UErrorCode *status)
 Open a UCalendar.
void ucal_close (UCalendar *cal)
 Close a UCalendar.
UCalendarucal_clone (const UCalendar *cal, UErrorCode *status)
 Open a copy of a UCalendar.
void ucal_setTimeZone (UCalendar *cal, const UChar *zoneID, int32_t len, UErrorCode *status)
 Set the TimeZone used by a UCalendar.
int32_t ucal_getTimeZoneDisplayName (const UCalendar *cal, UCalendarDisplayNameType type, const char *locale, UChar *result, int32_t resultLength, UErrorCode *status)
 Get the display name for a UCalendar's TimeZone.
UBool ucal_inDaylightTime (const UCalendar *cal, UErrorCode *status)
 Determine if a UCalendar is currently in daylight savings time.
void ucal_setGregorianChange (UCalendar *cal, UDate date, UErrorCode *pErrorCode)
 Sets the GregorianCalendar change date.
UDate ucal_getGregorianChange (const UCalendar *cal, UErrorCode *pErrorCode)
 Gets the Gregorian Calendar change date.
int32_t ucal_getAttribute (const UCalendar *cal, UCalendarAttribute attr)
 Get a numeric attribute associated with a UCalendar.
void ucal_setAttribute (UCalendar *cal, UCalendarAttribute attr, int32_t newValue)
 Set a numeric attribute associated with a UCalendar.
const char * ucal_getAvailable (int32_t localeIndex)
 Get a locale for which calendars are available.
int32_t ucal_countAvailable (void)
 Determine how many locales have calendars available.
UDate ucal_getMillis (const UCalendar *cal, UErrorCode *status)
 Get a UCalendar's current time in millis.
void ucal_setMillis (UCalendar *cal, UDate dateTime, UErrorCode *status)
 Set a UCalendar's current time in millis.
void ucal_setDate (UCalendar *cal, int32_t year, int32_t month, int32_t date, UErrorCode *status)
 Set a UCalendar's current date.
void ucal_setDateTime (UCalendar *cal, int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode *status)
 Set a UCalendar's current date.
UBool ucal_equivalentTo (const UCalendar *cal1, const UCalendar *cal2)
 Returns TRUE if two UCalendars are equivalent.
void ucal_add (UCalendar *cal, UCalendarDateFields field, int32_t amount, UErrorCode *status)
 Add a specified signed amount to a particular field in a UCalendar.
void ucal_roll (UCalendar *cal, UCalendarDateFields field, int32_t amount, UErrorCode *status)
 Add a specified signed amount to a particular field in a UCalendar.
int32_t ucal_get (const UCalendar *cal, UCalendarDateFields field, UErrorCode *status)
 Get the current value of a field from a UCalendar.
void ucal_set (UCalendar *cal, UCalendarDateFields field, int32_t value)
 Set the value of a field in a UCalendar.
UBool ucal_isSet (const UCalendar *cal, UCalendarDateFields field)
 Determine if a field in a UCalendar is set.
void ucal_clearField (UCalendar *cal, UCalendarDateFields field)
 Clear a field in a UCalendar.
void ucal_clear (UCalendar *calendar)
 Clear all fields in a UCalendar.
int32_t ucal_getLimit (const UCalendar *cal, UCalendarDateFields field, UCalendarLimitType type, UErrorCode *status)
 Determine a limit for a field in a UCalendar.
const char * ucal_getLocaleByType (const UCalendar *cal, ULocDataLocaleType type, UErrorCode *status)
 Get the locale for this calendar object.
const char * ucal_getTZDataVersion (UErrorCode *status)
 Returns the timezone data version currently used by ICU.
int32_t ucal_getCanonicalTimeZoneID (const UChar *id, int32_t len, UChar *result, int32_t resultCapacity, UBool *isSystemID, UErrorCode *status)
 Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID.
const char * ucal_getType (const UCalendar *cal, UErrorCode *status)
 Get the resource keyword value string designating the calendar type for the UCalendar.
UEnumerationucal_getKeywordValuesForLocale (const char *key, const char *locale, UBool commonlyUsed, UErrorCode *status)
 Given a key and a locale, returns an array of string values in a preferred order that would make a difference.
UCalendarWeekdayType ucal_getDayOfWeekType (const UCalendar *cal, UCalendarDaysOfWeek dayOfWeek, UErrorCode *status)
 Returns whether the given day of the week is a weekday, a weekend day, or a day that transitions from one to the other, in this calendar system.
int32_t ucal_getWeekendTransition (const UCalendar *cal, UCalendarDaysOfWeek dayOfWeek, UErrorCode *status)
 Returns the time during the day at which the weekend begins or ends in this calendar system.
UBool ucal_isWeekend (const UCalendar *cal, UDate date, UErrorCode *status)
 Returns TRUE if the given UDate is in the weekend in this calendar system.

Detailed Description

C API: Calendar.

Calendar C API

UCalendar C API is used for converting between a UDate object and a set of integer fields such as UCAL_YEAR, UCAL_MONTH, UCAL_DAY, UCAL_HOUR, and so on. (A UDate object represents a specific instant in time with millisecond precision. See UDate for information about the UDate .)

Types of UCalendar interpret a UDate according to the rules of a specific calendar system. The U_STABLE provides the enum UCalendarType with UCAL_TRADITIONAL and UCAL_GREGORIAN.

Like other locale-sensitive C API, calendar API provides a function, ucal_open(), which returns a pointer to UCalendar whose time fields have been initialized with the current date and time. We need to specify the type of calendar to be opened and the timezoneId.

 
 UCalendar *caldef;
 UChar *tzId;
 UErrorCode status;
 tzId=(UChar*)malloc(sizeof(UChar) * (strlen("PST") +1) );
 u_uastrcpy(tzId, "PST");
 caldef=ucal_open(tzID, u_strlen(tzID), NULL, UCAL_TRADITIONAL, &status);

A UCalendar object can produce all the time field values needed to implement the date-time formatting for a particular language and calendar style (for example, Japanese-Gregorian, Japanese-Traditional).

When computing a UDate from time fields, two special circumstances may arise: there may be insufficient information to compute the UDate (such as only year and month but no day in the month), or there may be inconsistent information (such as "Tuesday, July 15, 1996" -- July 15, 1996 is actually a Monday).

Insufficient information. The calendar will use default information to specify the missing fields. This may vary by calendar; for the Gregorian calendar, the default for a field is the same as that of the start of the epoch: i.e., UCAL_YEAR = 1970, UCAL_MONTH = JANUARY, UCAL_DATE = 1, etc.

Inconsistent information. If fields conflict, the calendar will give preference to fields set more recently. For example, when determining the day, the calendar will look for one of the following combinations of fields. The most recent combination, as determined by the most recently set single field, will be used.

 
 

For the time of day:

 
 

Note: for some non-Gregorian calendars, different fields may be necessary for complete disambiguation. For example, a full specification of the historial Arabic astronomical calendar requires year, month, day-of-month and day-of-week in some cases.

Note: There are certain possible ambiguities in interpretation of certain singular times, which are resolved in the following ways:

  1. 24:00:00 "belongs" to the following day. That is, 23:59 on Dec 31, 1969 < 24:00 on Jan 1, 1970 < 24:01:00 on Jan 1, 1970

  2. Although historically not precise, midnight also belongs to "am", and noon belongs to "pm", so on the same day, 12:00 am (midnight) < 12:01 am, and 12:00 pm (noon) < 12:01 pm

The date or time format strings are not part of the definition of a calendar, as those must be modifiable or overridable by the user at runtime. Use DateFormat to format dates.

Calendar provides an API for field "rolling", where fields can be incremented or decremented, but wrap around. For example, rolling the month up in the date December 12, 1996 results in January 12, 1996.

Calendar also provides a date arithmetic function for adding the specified (signed) amount of time to a particular time field. For example, subtracting 5 days from the date September 12, 1996 results in September 7, 1996.

Stable:
ICU 2.0

Definition in file ucal.h.


Typedef Documentation

typedef void* UCalendar

A calendar.

For usage in C programs.

Stable:
ICU 2.0

Definition at line 147 of file ucal.h.

Stable:
ICU 2.0

Definition at line 516 of file ucal.h.

Stable:
ICU 2.0

Definition at line 805 of file ucal.h.

Stable:
ICU 2.0

Definition at line 438 of file ucal.h.

Stable:
ICU 2.0

Definition at line 465 of file ucal.h.

Stable:
ICU 2.0

Definition at line 710 of file ucal.h.

Stable:
ICU 2.0

Definition at line 1106 of file ucal.h.

Stable:
ICU 2.0

Definition at line 503 of file ucal.h.

Stable:
ICU 2.0

Definition at line 172 of file ucal.h.

Draft:
This API may be changed in the future versions and was introduced in ICU 4.4

Definition at line 1226 of file ucal.h.


Enumeration Type Documentation

Possible AM/PM values in a UCalendar.

Stable:
ICU 2.0
Enumerator:
UCAL_AM 

AM.

UCAL_PM 

PM.

Definition at line 508 of file ucal.h.

Types of UCalendar attributes.

Stable:
ICU 2.0
Enumerator:
UCAL_LENIENT 

Lenient parsing.

UCAL_FIRST_DAY_OF_WEEK 

First day of week.

UCAL_MINIMAL_DAYS_IN_FIRST_WEEK 

Minimum number of days in first week.

Definition at line 795 of file ucal.h.

Possible fields in a UCalendar.

Stable:
ICU 2.0
Enumerator:
UCAL_ERA 

Field number indicating the era, e.g., AD or BC in the Gregorian (Julian) calendar.

This is a calendar-specific value.

Stable:
ICU 2.6
UCAL_YEAR 

Field number indicating the year.

This is a calendar-specific value.

Stable:
ICU 2.6
UCAL_MONTH 

Field number indicating the month.

This is a calendar-specific value. The first month of the year is JANUARY; the last depends on the number of months in a year.

See also:
UCAL_JANUARY
UCAL_FEBRUARY
UCAL_MARCH
UCAL_APRIL
UCAL_MAY
UCAL_JUNE
UCAL_JULY
UCAL_AUGUST
UCAL_SEPTEMBER
UCAL_OCTOBER
UCAL_NOVEMBER
UCAL_DECEMBER
UCAL_UNDECIMBER
Stable:
ICU 2.6
UCAL_WEEK_OF_YEAR 

Field number indicating the week number within the current year.

The first week of the year, as defined by UCAL_FIRST_DAY_OF_WEEK and UCAL_MINIMAL_DAYS_IN_FIRST_WEEK attributes, has value 1. Subclasses define the value of UCAL_WEEK_OF_YEAR for days before the first week of the year.

See also:
ucal_getAttribute
ucal_setAttribute
Stable:
ICU 2.6
UCAL_WEEK_OF_MONTH 

Field number indicating the week number within the current month.

The first week of the month, as defined by UCAL_FIRST_DAY_OF_WEEK and UCAL_MINIMAL_DAYS_IN_FIRST_WEEK attributes, has value 1. Subclasses define the value of WEEK_OF_MONTH for days before the first week of the month.

See also:
ucal_getAttribute
ucal_setAttribute
UCAL_FIRST_DAY_OF_WEEK
UCAL_MINIMAL_DAYS_IN_FIRST_WEEK
Stable:
ICU 2.6
UCAL_DATE 

Field number indicating the day of the month.

This is a synonym for DAY_OF_MONTH. The first day of the month has value 1.

See also:
UCAL_DAY_OF_MONTH
Stable:
ICU 2.6
UCAL_DAY_OF_YEAR 

Field number indicating the day number within the current year.

The first day of the year has value 1.

Stable:
ICU 2.6
UCAL_DAY_OF_WEEK 

Field number indicating the day of the week.

This field takes values SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, and SATURDAY.

See also:
UCAL_SUNDAY
UCAL_MONDAY
UCAL_TUESDAY
UCAL_WEDNESDAY
UCAL_THURSDAY
UCAL_FRIDAY
UCAL_SATURDAY
Stable:
ICU 2.6
UCAL_DAY_OF_WEEK_IN_MONTH 

Field number indicating the ordinal number of the day of the week within the current month.

Together with the DAY_OF_WEEK field, this uniquely specifies a day within a month. Unlike WEEK_OF_MONTH and WEEK_OF_YEAR, this field's value does not depend on getFirstDayOfWeek() or getMinimalDaysInFirstWeek(). DAY_OF_MONTH 1 through 7 always correspond to DAY_OF_WEEK_IN_MONTH 1; 8 through 15 correspond to DAY_OF_WEEK_IN_MONTH 2, and so on. DAY_OF_WEEK_IN_MONTH 0 indicates the week before DAY_OF_WEEK_IN_MONTH 1. Negative values count back from the end of the month, so the last Sunday of a month is specified as DAY_OF_WEEK = SUNDAY, DAY_OF_WEEK_IN_MONTH = -1. Because negative values count backward they will usually be aligned differently within the month than positive values. For example, if a month has 31 days, DAY_OF_WEEK_IN_MONTH -1 will overlap DAY_OF_WEEK_IN_MONTH 5 and the end of 4.

See also:
UCAL_DAY_OF_WEEK
UCAL_WEEK_OF_MONTH
Stable:
ICU 2.6
UCAL_AM_PM 

Field number indicating whether the HOUR is before or after noon.

E.g., at 10:04:15.250 PM the AM_PM is PM.

See also:
UCAL_AM
UCAL_PM
UCAL_HOUR
Stable:
ICU 2.6
UCAL_HOUR 

Field number indicating the hour of the morning or afternoon.

HOUR is used for the 12-hour clock. E.g., at 10:04:15.250 PM the HOUR is 10.

See also:
UCAL_AM_PM
UCAL_HOUR_OF_DAY
Stable:
ICU 2.6
UCAL_HOUR_OF_DAY 

Field number indicating the hour of the day.

HOUR_OF_DAY is used for the 24-hour clock. E.g., at 10:04:15.250 PM the HOUR_OF_DAY is 22.

See also:
UCAL_HOUR
Stable:
ICU 2.6
UCAL_MINUTE 

Field number indicating the minute within the hour.

E.g., at 10:04:15.250 PM the UCAL_MINUTE is 4.

Stable:
ICU 2.6
UCAL_SECOND 

Field number indicating the second within the minute.

E.g., at 10:04:15.250 PM the UCAL_SECOND is 15.

Stable:
ICU 2.6
UCAL_MILLISECOND 

Field number indicating the millisecond within the second.

E.g., at 10:04:15.250 PM the UCAL_MILLISECOND is 250.

Stable:
ICU 2.6
UCAL_ZONE_OFFSET 

Field number indicating the raw offset from GMT in milliseconds.

Stable:
ICU 2.6
UCAL_DST_OFFSET 

Field number indicating the daylight savings offset in milliseconds.

Stable:
ICU 2.6
UCAL_YEAR_WOY 

Field number indicating the extended year corresponding to the UCAL_WEEK_OF_YEAR field.

This may be one greater or less than the value of UCAL_EXTENDED_YEAR.

Stable:
ICU 2.6
UCAL_DOW_LOCAL 

Field number indicating the localized day of week.

This will be a value from 1 to 7 inclusive, with 1 being the localized first day of the week.

Stable:
ICU 2.6
UCAL_EXTENDED_YEAR 

Year of this calendar system, encompassing all supra-year fields.

For example, in Gregorian/Julian calendars, positive Extended Year values indicate years AD, 1 BC = 0 extended, 2 BC = -1 extended, and so on.

Stable:
ICU 2.8
UCAL_JULIAN_DAY 

Field number indicating the modified Julian day number.

This is different from the conventional Julian day number in two regards. First, it demarcates days at local zone midnight, rather than noon GMT. Second, it is a local number; that is, it depends on the local time zone. It can be thought of as a single number that encompasses all the date-related fields.

Stable:
ICU 2.8
UCAL_MILLISECONDS_IN_DAY 

Ranges from 0 to 23:59:59.999 (regardless of DST).

This field behaves exactly like a composite of all time-related fields, not including the zone fields. As such, it also reflects discontinuities of those fields on DST transition days. On a day of DST onset, it will jump forward. On a day of DST cessation, it will jump backward. This reflects the fact that it must be combined with the DST_OFFSET field to obtain a unique local time value.

Stable:
ICU 2.8
UCAL_IS_LEAP_MONTH 

Whether or not the current month is a leap month (0 or 1).

See the Chinese calendar for an example of this.

UCAL_FIELD_COUNT 

Field count.

Stable:
ICU 2.6
UCAL_DAY_OF_MONTH 

Field number indicating the day of the month.

This is a synonym for UCAL_DATE. The first day of the month has value 1.

See also:
UCAL_DATE Synonym for UCAL_DATE
Stable:
ICU 2.8

Definition at line 177 of file ucal.h.

Useful constant for days of week.

Note: Calendar day-of-week is 1-based. Clients who create locale resources for the field of first-day-of-week should be aware of this. For instance, in US locale, first-day-of-week is set to 1, i.e., UCAL_SUNDAY. Possible days of the week in a UCalendar

Stable:
ICU 2.0
Enumerator:
UCAL_SUNDAY 

Sunday.

UCAL_MONDAY 

Monday.

UCAL_TUESDAY 

Tuesday.

UCAL_WEDNESDAY 

Wednesday.

UCAL_THURSDAY 

Thursday.

UCAL_FRIDAY 

Friday.

UCAL_SATURDAY 

Saturday.

Definition at line 447 of file ucal.h.

Possible formats for a UCalendar's display name.

Stable:
ICU 2.0
Enumerator:
UCAL_STANDARD 

Standard display name.

UCAL_SHORT_STANDARD 

Short standard display name.

UCAL_DST 

Daylight savings display name.

UCAL_SHORT_DST 

Short daylight savings display name.

Definition at line 698 of file ucal.h.

Possible limit values for a UCalendar.

Stable:
ICU 2.0
Enumerator:
UCAL_MINIMUM 

Minimum value.

UCAL_MAXIMUM 

Maximum value.

UCAL_GREATEST_MINIMUM 

Greatest minimum value.

UCAL_LEAST_MAXIMUM 

Leaest maximum value.

UCAL_ACTUAL_MINIMUM 

Actual minimum value.

UCAL_ACTUAL_MAXIMUM 

Actual maximum value.

Definition at line 1090 of file ucal.h.

Possible months in a UCalendar.

Note: Calendar month is 0-based.

Stable:
ICU 2.0
Enumerator:
UCAL_JANUARY 

January.

UCAL_FEBRUARY 

February.

UCAL_MARCH 

March.

UCAL_APRIL 

April.

UCAL_MAY 

May.

UCAL_JUNE 

June.

UCAL_JULY 

July.

UCAL_AUGUST 

August.

UCAL_SEPTEMBER 

September.

UCAL_OCTOBER 

October.

UCAL_NOVEMBER 

November.

UCAL_DECEMBER 

December.

UCAL_UNDECIMBER 

Value of the UCAL_MONTH field indicating the thirteenth month of the year.

Although the Gregorian calendar does not use this value, lunar calendars do.

Definition at line 470 of file ucal.h.

Possible types of UCalendars.

Stable:
ICU 2.0
Enumerator:
UCAL_TRADITIONAL 

Despite the name, UCAL_TRADITIONAL designates the locale's default calendar, which may be the Gregorian calendar or some other calendar.

Stable:
ICU 2.0
UCAL_DEFAULT 

A better name for UCAL_TRADITIONAL.

Stable:
ICU 4.4
UCAL_GREGORIAN 

Unambiguously designates the Gregorian calendar for the locale.

Stable:
ICU 2.0

Definition at line 152 of file ucal.h.

Weekday types, as returned by ucal_getDayOfWeekType().

Draft:
This API may be changed in the future versions and was introduced in ICU 4.4
Enumerator:
UCAL_WEEKDAY 

Designates a full weekday (no part of the day is included in the weekend).

UCAL_WEEKEND 

Designates a full weekend day (the entire day is included in the weekend).

UCAL_WEEKEND_ONSET 

Designates a day that starts as a weekday and transitions to the weekend.

Call ucal_getWeekendTransition() to get the time of transition.

UCAL_WEEKEND_CEASE 

Designates a day that starts as the weekend and transitions to a weekday.

Call ucal_getWeekendTransition() to get the time of transition.

Definition at line 1204 of file ucal.h.


Function Documentation

void ucal_add ( UCalendar cal,
UCalendarDateFields  field,
int32_t  amount,
UErrorCode status 
)

Add a specified signed amount to a particular field in a UCalendar.

This can modify more significant fields in the calendar.

Parameters:
cal The UCalendar to which to add.
field The field to which to add the signed value; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
amount The signed amount to add to field. If the amount causes the value to exceed to maximum or minimum values for that field, other fields are modified to preserve the magnitude of the change.
status A pointer to an UErrorCode to receive any errors
See also:
ucal_roll
Stable:
ICU 2.0
void ucal_clear ( UCalendar calendar  ) 

Clear all fields in a UCalendar.

All fields are represented as 32-bit integers.

Parameters:
calendar The UCalendar to clear.
See also:
ucal_get
ucal_set
ucal_isSet
ucal_clearField
Stable:
ICU 2.0
void ucal_clearField ( UCalendar cal,
UCalendarDateFields  field 
)

Clear a field in a UCalendar.

All fields are represented as 32-bit integers.

Parameters:
cal The UCalendar containing the field to clear.
field The field to clear; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
See also:
ucal_get
ucal_set
ucal_isSet
ucal_clear
Stable:
ICU 2.0
UCalendar* ucal_clone ( const UCalendar cal,
UErrorCode status 
)

Open a copy of a UCalendar.

This function performs a deep copy.

Parameters:
cal The calendar to copy
status A pointer to an UErrorCode to receive any errors.
Returns:
A pointer to a UCalendar identical to cal.
Stable:
ICU 4.0
void ucal_close ( UCalendar cal  ) 

Close a UCalendar.

Once closed, a UCalendar may no longer be used.

Parameters:
cal The UCalendar to close.
Stable:
ICU 2.0
int32_t ucal_countAvailable ( void   ) 

Determine how many locales have calendars available.

This function is most useful as determining the loop ending condition for calls to ucal_getAvailable.

Returns:
The number of locales for which calendars are available.
See also:
ucal_getAvailable
Stable:
ICU 2.0
UBool ucal_equivalentTo ( const UCalendar cal1,
const UCalendar cal2 
)

Returns TRUE if two UCalendars are equivalent.

Equivalent UCalendars will behave identically, but they may be set to different times.

Parameters:
cal1 The first of the UCalendars to compare.
cal2 The second of the UCalendars to compare.
Returns:
TRUE if cal1 and cal2 are equivalent, FALSE otherwise.
Stable:
ICU 2.0
int32_t ucal_get ( const UCalendar cal,
UCalendarDateFields  field,
UErrorCode status 
)

Get the current value of a field from a UCalendar.

All fields are represented as 32-bit integers.

Parameters:
cal The UCalendar to query.
field The desired field; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
status A pointer to an UErrorCode to receive any errors
Returns:
The value of the desired field.
See also:
ucal_set
ucal_isSet
ucal_clearField
ucal_clear
Stable:
ICU 2.0
int32_t ucal_getAttribute ( const UCalendar cal,
UCalendarAttribute  attr 
)

Get a numeric attribute associated with a UCalendar.

Numeric attributes include the first day of the week, or the minimal numbers of days in the first week of the month.

Parameters:
cal The UCalendar to query.
attr The desired attribute; one of UCAL_LENIENT, UCAL_FIRST_DAY_OF_WEEK, or UCAL_MINIMAL_DAYS_IN_FIRST_WEEK
Returns:
The value of attr.
See also:
ucal_setAttribute
Stable:
ICU 2.0
const char* ucal_getAvailable ( int32_t  localeIndex  ) 

Get a locale for which calendars are available.

A UCalendar in a locale returned by this function will contain the correct day and month names for the locale.

Parameters:
localeIndex The index of the desired locale.
Returns:
A locale for which calendars are available, or 0 if none.
See also:
ucal_countAvailable
Stable:
ICU 2.0
int32_t ucal_getCanonicalTimeZoneID ( const UChar id,
int32_t  len,
UChar result,
int32_t  resultCapacity,
UBool isSystemID,
UErrorCode status 
)

Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID.

Parameters:
id The input timezone ID to be canonicalized.
len The length of id, or -1 if null-terminated.
result The buffer receives the canonical system timezone ID or the custom timezone ID in normalized format.
resultCapacity The capacity of the result buffer.
isSystemID Receives if the given ID is a known system timezone ID.
status Recevies the status. When the given timezone ID is neither a known system time zone ID nor a valid custom timezone ID, U_ILLEGAL_ARGUMENT_ERROR is set.
Returns:
The result string length, not including the terminating null.
Stable:
ICU 4.0
UCalendarWeekdayType ucal_getDayOfWeekType ( const UCalendar cal,
UCalendarDaysOfWeek  dayOfWeek,
UErrorCode status 
)

Returns whether the given day of the week is a weekday, a weekend day, or a day that transitions from one to the other, in this calendar system.

If a transition occurs at midnight, then the days before and after the transition will have the type UCAL_WEEKDAY or UCAL_WEEKEND. If a transition occurs at a time other than midnight, then the day of the transition will have the type UCAL_WEEKEND_ONSET or UCAL_WEEKEND_CEASE. In this case, the method getWeekendTransition() will return the point of transition.

Parameters:
cal The UCalendar to query.
dayOfWeek The day of the week whose type is desired (UCAL_SUNDAY..UCAL_SATURDAY).
status The error code for the operation.
Returns:
The UCalendarWeekdayType for the day of the week.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.4
int32_t ucal_getDefaultTimeZone ( UChar result,
int32_t  resultCapacity,
UErrorCode ec 
)

Return the default time zone.

The default is determined initially by querying the host operating system. It may be changed with ucal_setDefaultTimeZone() or with the C++ TimeZone API.

Parameters:
result A buffer to receive the result, or NULL
resultCapacity The capacity of the result buffer
ec input/output error code
Returns:
The result string length, not including the terminating null
Stable:
ICU 2.6
int32_t ucal_getDSTSavings ( const UChar zoneID,
UErrorCode ec 
)

Return the amount of time in milliseconds that the clock is advanced during daylight savings time for the given time zone, or zero if the time zone does not observe daylight savings time.

Parameters:
zoneID null-terminated time zone ID
ec input/output error code
Returns:
the number of milliseconds the time is advanced with respect to standard time when the daylight savings rules are in effect. This is always a non-negative number, most commonly either 3,600,000 (one hour) or zero.
Stable:
ICU 2.6
UDate ucal_getGregorianChange ( const UCalendar cal,
UErrorCode pErrorCode 
)

Gets the Gregorian Calendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

This function works only for Gregorian calendars. If the UCalendar is not an instance of a Gregorian calendar, then a U_UNSUPPORTED_ERROR error code is set.

Parameters:
cal The calendar object.
pErrorCode Pointer to a standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
Returns:
The Gregorian cutover time for this calendar.
See also:
GregorianCalendar::getGregorianChange
ucal_setGregorianChange
Stable:
ICU 3.6
UEnumeration* ucal_getKeywordValuesForLocale ( const char *  key,
const char *  locale,
UBool  commonlyUsed,
UErrorCode status 
)

Given a key and a locale, returns an array of string values in a preferred order that would make a difference.

These are all and only those values where the open (creation) of the service with the locale formed from the input locale plus input keyword and that value has different behavior than creation with the input locale alone.

Parameters:
key one of the keys supported by this service. For now, only "calendar" is supported.
locale the locale
commonlyUsed if set to true it will return only commonly used values with the given locale in preferred order. Otherwise, it will return all the available values for the locale.
status error status
Returns:
a string enumeration over keyword values for the given key and the locale.
Stable:
ICU 4.4
int32_t ucal_getLimit ( const UCalendar cal,
UCalendarDateFields  field,
UCalendarLimitType  type,
UErrorCode status 
)

Determine a limit for a field in a UCalendar.

A limit is a maximum or minimum value for a field.

Parameters:
cal The UCalendar to query.
field The desired field; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
type The desired critical point; one of UCAL_MINIMUM, UCAL_MAXIMUM, UCAL_GREATEST_MINIMUM, UCAL_LEAST_MAXIMUM, UCAL_ACTUAL_MINIMUM, UCAL_ACTUAL_MAXIMUM
status A pointer to an UErrorCode to receive any errors.
Returns:
The requested value.
Stable:
ICU 2.0
const char* ucal_getLocaleByType ( const UCalendar cal,
ULocDataLocaleType  type,
UErrorCode status 
)

Get the locale for this calendar object.

You can choose between valid and actual locale.

Parameters:
cal The calendar object
type type of the locale we're looking for (valid or actual)
status error code for the operation
Returns:
the locale name
Stable:
ICU 2.8
UDate ucal_getMillis ( const UCalendar cal,
UErrorCode status 
)

Get a UCalendar's current time in millis.

The time is represented as milliseconds from the epoch.

Parameters:
cal The UCalendar to query.
status A pointer to an UErrorCode to receive any errors
Returns:
The calendar's current time in millis.
See also:
ucal_setMillis
ucal_setDate
ucal_setDateTime
Stable:
ICU 2.0
UDate ucal_getNow ( void   ) 

Get the current date and time.

The value returned is represented as milliseconds from the epoch.

Returns:
The current date and time.
Stable:
ICU 2.0
int32_t ucal_getTimeZoneDisplayName ( const UCalendar cal,
UCalendarDisplayNameType  type,
const char *  locale,
UChar result,
int32_t  resultLength,
UErrorCode status 
)

Get the display name for a UCalendar's TimeZone.

A display name is suitable for presentation to a user.

Parameters:
cal The UCalendar to query.
type The desired display name format; one of UCAL_STANDARD, UCAL_SHORT_STANDARD, UCAL_DST, UCAL_SHORT_DST
locale The desired locale for the display name.
result A pointer to a buffer to receive the formatted number.
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.
Stable:
ICU 2.0
const char* ucal_getType ( const UCalendar cal,
UErrorCode status 
)

Get the resource keyword value string designating the calendar type for the UCalendar.

Parameters:
cal The UCalendar to query.
status The error code for the operation.
Returns:
The resource keyword value string.
Stable:
ICU 4.4
const char* ucal_getTZDataVersion ( UErrorCode status  ) 

Returns the timezone data version currently used by ICU.

Parameters:
status error code for the operation
Returns:
the version string, such as "2007f"
Stable:
ICU 3.8
int32_t ucal_getWeekendTransition ( const UCalendar cal,
UCalendarDaysOfWeek  dayOfWeek,
UErrorCode status 
)

Returns the time during the day at which the weekend begins or ends in this calendar system.

If ucal_getDayOfWeekType() rerturns UCAL_WEEKEND_ONSET for the specified dayOfWeek, return the time at which the weekend begins. If ucal_getDayOfWeekType() returns UCAL_WEEKEND_CEASE for the specified dayOfWeek, return the time at which the weekend ends. If ucal_getDayOfWeekType() returns some other UCalendarWeekdayType for the specified dayOfWeek, is it an error condition (U_ILLEGAL_ARGUMENT_ERROR).

Parameters:
cal The UCalendar to query.
dayOfWeek The day of the week for which the weekend transition time is desired (UCAL_SUNDAY..UCAL_SATURDAY).
status The error code for the operation.
Returns:
The milliseconds after midnight at which the weekend begins or ends.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.4
UBool ucal_inDaylightTime ( const UCalendar cal,
UErrorCode status 
)

Determine if a UCalendar is currently in daylight savings time.

Daylight savings time is not used in all parts of the world.

Parameters:
cal The UCalendar to query.
status A pointer to an UErrorCode to receive any errors
Returns:
TRUE if cal is currently in daylight savings time, FALSE otherwise
Stable:
ICU 2.0
UBool ucal_isSet ( const UCalendar cal,
UCalendarDateFields  field 
)

Determine if a field in a UCalendar is set.

All fields are represented as 32-bit integers.

Parameters:
cal The UCalendar to query.
field The desired field; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
Returns:
TRUE if field is set, FALSE otherwise.
See also:
ucal_get
ucal_set
ucal_clearField
ucal_clear
Stable:
ICU 2.0
UBool ucal_isWeekend ( const UCalendar cal,
UDate  date,
UErrorCode status 
)

Returns TRUE if the given UDate is in the weekend in this calendar system.

Parameters:
cal The UCalendar to query.
date The UDate in question.
status The error code for the operation.
Returns:
TRUE if the given UDate is in the weekend in this calendar system, FALSE otherwise.
Draft:
This API may be changed in the future versions and was introduced in ICU 4.4
UCalendar* ucal_open ( const UChar zoneID,
int32_t  len,
const char *  locale,
UCalendarType  type,
UErrorCode status 
)

Open a UCalendar.

A UCalendar may be used to convert a millisecond value to a year, month, and day.

Note: When unknown TimeZone ID is specified, the UCalendar returned by the function is initialized with GMT ("Etc/GMT") without any errors/warnings. If you want to check if a TimeZone ID is valid, use ucal_getCanonicalTimeZoneID prior to this function.

Parameters:
zoneID The desired TimeZone ID. If 0, use the default time zone.
len The length of zoneID, or -1 if null-terminated.
locale The desired locale
type The type of UCalendar to open. This can be UCAL_GREGORIAN to open the Gregorian calendar for the locale, or UCAL_DEFAULT to open the default calendar for the locale (the default calendar may also be Gregorian). To open a specific non-Gregorian calendar for the locale, use uloc_setKeywordValue to set the value of the calendar keyword for the locale and then pass the locale to ucal_open with UCAL_DEFAULT as the type.
status A pointer to an UErrorCode to receive any errors
Returns:
A pointer to a UCalendar, or 0 if an error occurred.
Stable:
ICU 2.0
UEnumeration* ucal_openCountryTimeZones ( const char *  country,
UErrorCode ec 
)

Create an enumeration over all time zones associated with the given country.

Some zones are affiliated with no country (e.g., "UTC"); these may also be retrieved, as a group.

Parameters:
country the ISO 3166 two-letter country code, or NULL to retrieve zones not affiliated with any country
ec input/output error code
Returns:
an enumeration object that the caller must dispose of using uenum_close(), or NULL upon failure. In case of failure *ec will indicate the error.
Stable:
ICU 2.6
UEnumeration* ucal_openTimeZones ( UErrorCode ec  ) 

Create an enumeration over all time zones.

Parameters:
ec input/output error code
Returns:
an enumeration object that the caller must dispose of using uenum_close(), or NULL upon failure. In case of failure *ec will indicate the error.
Stable:
ICU 2.6
void ucal_roll ( UCalendar cal,
UCalendarDateFields  field,
int32_t  amount,
UErrorCode status 
)

Add a specified signed amount to a particular field in a UCalendar.

This will not modify more significant fields in the calendar.

Parameters:
cal The UCalendar to which to add.
field The field to which to add the signed value; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
amount The signed amount to add to field. If the amount causes the value to exceed to maximum or minimum values for that field, the field is pinned to a permissible value.
status A pointer to an UErrorCode to receive any errors
See also:
ucal_add
Stable:
ICU 2.0
void ucal_set ( UCalendar cal,
UCalendarDateFields  field,
int32_t  value 
)

Set the value of a field in a UCalendar.

All fields are represented as 32-bit integers.

Parameters:
cal The UCalendar to set.
field The field to set; one of UCAL_ERA, UCAL_YEAR, UCAL_MONTH, UCAL_WEEK_OF_YEAR, UCAL_WEEK_OF_MONTH, UCAL_DATE, UCAL_DAY_OF_YEAR, UCAL_DAY_OF_WEEK, UCAL_DAY_OF_WEEK_IN_MONTH, UCAL_AM_PM, UCAL_HOUR, UCAL_HOUR_OF_DAY, UCAL_MINUTE, UCAL_SECOND, UCAL_MILLISECOND, UCAL_ZONE_OFFSET, UCAL_DST_OFFSET.
value The desired value of field.
See also:
ucal_get
ucal_isSet
ucal_clearField
ucal_clear
Stable:
ICU 2.0
void ucal_setAttribute ( UCalendar cal,
UCalendarAttribute  attr,
int32_t  newValue 
)

Set a numeric attribute associated with a UCalendar.

Numeric attributes include the first day of the week, or the minimal numbers of days in the first week of the month.

Parameters:
cal The UCalendar to set.
attr The desired attribute; one of UCAL_LENIENT, UCAL_FIRST_DAY_OF_WEEK, or UCAL_MINIMAL_DAYS_IN_FIRST_WEEK
newValue The new value of attr.
See also:
ucal_getAttribute
Stable:
ICU 2.0
void ucal_setDate ( UCalendar cal,
int32_t  year,
int32_t  month,
int32_t  date,
UErrorCode status 
)

Set a UCalendar's current date.

The date is represented as a series of 32-bit integers.

Parameters:
cal The UCalendar to set.
year The desired year.
month The desired month; one of UCAL_JANUARY, UCAL_FEBRUARY, UCAL_MARCH, UCAL_APRIL, UCAL_MAY, UCAL_JUNE, UCAL_JULY, UCAL_AUGUST, UCAL_SEPTEMBER, UCAL_OCTOBER, UCAL_NOVEMBER, UCAL_DECEMBER, UCAL_UNDECIMBER
date The desired day of the month.
status A pointer to an UErrorCode to receive any errors
See also:
ucal_getMillis
ucal_setMillis
ucal_setDateTime
Stable:
ICU 2.0
void ucal_setDateTime ( UCalendar cal,
int32_t  year,
int32_t  month,
int32_t  date,
int32_t  hour,
int32_t  minute,
int32_t  second,
UErrorCode status 
)

Set a UCalendar's current date.

The date is represented as a series of 32-bit integers.

Parameters:
cal The UCalendar to set.
year The desired year.
month The desired month; one of UCAL_JANUARY, UCAL_FEBRUARY, UCAL_MARCH, UCAL_APRIL, UCAL_MAY, UCAL_JUNE, UCAL_JULY, UCAL_AUGUST, UCAL_SEPTEMBER, UCAL_OCTOBER, UCAL_NOVEMBER, UCAL_DECEMBER, UCAL_UNDECIMBER
date The desired day of the month.
hour The desired hour of day.
minute The desired minute.
second The desirec second.
status A pointer to an UErrorCode to receive any errors
See also:
ucal_getMillis
ucal_setMillis
ucal_setDate
Stable:
ICU 2.0
void ucal_setDefaultTimeZone ( const UChar zoneID,
UErrorCode ec 
)

Set the default time zone.

Parameters:
zoneID null-terminated time zone ID
ec input/output error code
Stable:
ICU 2.6
void ucal_setGregorianChange ( UCalendar cal,
UDate  date,
UErrorCode pErrorCode 
)

Sets the GregorianCalendar change date.

This is the point when the switch from Julian dates to Gregorian dates occurred. Default is 00:00:00 local time, October 15, 1582. Previous to this time and date will be Julian dates.

This function works only for Gregorian calendars. If the UCalendar is not an instance of a Gregorian calendar, then a U_UNSUPPORTED_ERROR error code is set.

Parameters:
cal The calendar object.
date The given Gregorian cutover date.
pErrorCode Pointer to a standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
See also:
GregorianCalendar::setGregorianChange
ucal_getGregorianChange
Stable:
ICU 3.6
void ucal_setMillis ( UCalendar cal,
UDate  dateTime,
UErrorCode status 
)

Set a UCalendar's current time in millis.

The time is represented as milliseconds from the epoch.

Parameters:
cal The UCalendar to set.
dateTime The desired date and time.
status A pointer to an UErrorCode to receive any errors
See also:
ucal_getMillis
ucal_setDate
ucal_setDateTime
Stable:
ICU 2.0
void ucal_setTimeZone ( UCalendar cal,
const UChar zoneID,
int32_t  len,
UErrorCode status 
)

Set the TimeZone used by a UCalendar.

A UCalendar uses a timezone for converting from Greenwich time to local time.

Parameters:
cal The UCalendar to set.
zoneID The desired TimeZone ID. If 0, use the default time zone.
len The length of zoneID, or -1 if null-terminated.
status A pointer to an UErrorCode to receive any errors.
Stable:
ICU 2.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sat Jan 23 15:17:36 2010 for ICU 4.3.4 by  doxygen 1.6.1