#include "unicode/utypes.h"
#include "unicode/uenum.h"
#include "unicode/uloc.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 |
Enumerations | |
enum | UCalendarType { 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... | |
Functions | |
UEnumeration * | ucal_openTimeZones (UErrorCode *ec) |
Create an enumeration over all time zones. | |
UEnumeration * | ucal_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. | |
UCalendar * | ucal_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. | |
UCalendar * | ucal_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 index) |
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. |
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:
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
.
Definition in file ucal.h.
typedef void* UCalendar |
typedef enum UCalendarAMPMs UCalendarAMPMs |
typedef enum UCalendarAttribute UCalendarAttribute |
typedef enum UCalendarDateFields UCalendarDateFields |
typedef enum UCalendarDaysOfWeek UCalendarDaysOfWeek |
typedef enum UCalendarDisplayNameType UCalendarDisplayNameType |
typedef enum UCalendarLimitType UCalendarLimitType |
typedef enum UCalendarMonths UCalendarMonths |
typedef enum UCalendarType UCalendarType |
enum UCalendarAMPMs |
enum UCalendarAttribute |
enum UCalendarDateFields |
Possible fields in a UCalendar.
UCAL_ERA |
Field number indicating the era, e.g., AD or BC in the Gregorian (Julian) calendar.
This is a calendar-specific value.
|
UCAL_YEAR |
Field number indicating the year.
This is a calendar-specific value.
|
UCAL_MONTH |
Field number indicating the month.
This is a calendar-specific value. The first month of the year is
|
UCAL_WEEK_OF_YEAR |
Field number indicating the week number within the current year.
The first week of the year, as defined by
|
UCAL_WEEK_OF_MONTH |
Field number indicating the week number within the current month.
The first week of the month, as defined by
|
UCAL_DATE |
Field number indicating the day of the month.
This is a synonym for
|
UCAL_DAY_OF_YEAR |
Field number indicating the day number within the current year.
The first day of the year has value 1.
|
UCAL_DAY_OF_WEEK |
Field number indicating the day of the week.
This field takes values
|
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
|
UCAL_AM_PM |
Field number indicating whether the HOUR is before or after noon.
E.g., at 10:04:15.250 PM the
|
UCAL_HOUR |
Field number indicating the hour of the morning or afternoon.
|
UCAL_HOUR_OF_DAY |
Field number indicating the hour of the day.
|
UCAL_MINUTE |
Field number indicating the minute within the hour.
E.g., at 10:04:15.250 PM the
|
UCAL_SECOND |
Field number indicating the second within the minute.
E.g., at 10:04:15.250 PM the
|
UCAL_MILLISECOND |
Field number indicating the millisecond within the second.
E.g., at 10:04:15.250 PM the
|
UCAL_ZONE_OFFSET |
Field number indicating the raw offset from GMT in milliseconds.
|
UCAL_DST_OFFSET |
Field number indicating the daylight savings offset in milliseconds.
|
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_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.
|
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.
|
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.
|
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.
|
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.
|
UCAL_DAY_OF_MONTH |
Field number indicating the day of the month.
This is a synonym for
|
enum UCalendarDaysOfWeek |
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
enum UCalendarLimitType |
Possible limit values for a UCalendar.
enum UCalendarMonths |
Possible months in a UCalendar.
Note: Calendar month is 0-based.
enum UCalendarType |
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.
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 |
void ucal_clear | ( | UCalendar * | calendar | ) |
void ucal_clearField | ( | UCalendar * | cal, | |
UCalendarDateFields | field | |||
) |
Clear a field in a UCalendar.
All fields are represented as 32-bit integers.
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. |
UCalendar* ucal_clone | ( | const UCalendar * | cal, | |
UErrorCode * | status | |||
) |
Open a copy of a UCalendar.
This function performs a deep copy.
cal | The calendar to copy | |
status | A pointer to an UErrorCode to receive any errors. |
void ucal_close | ( | UCalendar * | cal | ) |
Close a UCalendar.
Once closed, a UCalendar may no longer be used.
cal | The UCalendar to close. |
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 TRUE if two UCalendars are equivalent.
Equivalent UCalendars will behave identically, but they may be set to different times.
cal1 | The first of the UCalendars to compare. | |
cal2 | The second of the UCalendars to compare. |
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.
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 |
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.
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 |
const char* ucal_getAvailable | ( | int32_t | index | ) |
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.
index | The index of the desired locale. |
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.
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. |
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.
result | A buffer to receive the result, or NULL | |
resultCapacity | The capacity of the result buffer | |
ec | input/output error code |
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.
zoneID | null-terminated time zone ID | |
ec | input/output error code |
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.
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.) |
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.
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. |
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.
cal | The calendar object | |
type | type of the locale we're looking for (valid or actual) | |
status | error code for the operation |
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.
cal | The UCalendar to query. | |
status | A pointer to an UErrorCode to receive any errors |
UDate ucal_getNow | ( | void | ) |
Get the current date and time.
The value returned is represented as milliseconds from the epoch.
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.
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 |
const char* ucal_getTZDataVersion | ( | UErrorCode * | status | ) |
Returns the timezone data version currently used by ICU.
status | error code for the operation |
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.
cal | The UCalendar to query. | |
status | A pointer to an UErrorCode to receive any errors |
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.
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. |
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.
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. | |
status | A pointer to an UErrorCode to receive any errors |
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.
country | the ISO 3166 two-letter country code, or NULL to retrieve zones not affiliated with any country | |
ec | input/output error code |
UEnumeration* ucal_openTimeZones | ( | UErrorCode * | ec | ) |
Create an enumeration over all time zones.
ec | input/output error code |
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.
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 |
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.
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. |
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.
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. |
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.
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 |
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.
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 |
void ucal_setDefaultTimeZone | ( | const UChar * | zoneID, | |
UErrorCode * | ec | |||
) |
Set the default time zone.
zoneID | null-terminated time zone ID | |
ec | input/output error code |
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.
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.) |
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.
cal | The UCalendar to set. | |
dateTime | The desired date and time. | |
status | A pointer to an UErrorCode to receive any errors |
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.
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. |