ICU 62.1 62.1
ucal.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4 *******************************************************************************
5 * Copyright (C) 1996-2015, International Business Machines Corporation and
6 * others. All Rights Reserved.
7 *******************************************************************************
8 */
9
10#ifndef UCAL_H
11#define UCAL_H
12
13#include "unicode/utypes.h"
14#include "unicode/uenum.h"
15#include "unicode/uloc.h"
17
18#if !UCONFIG_NO_FORMATTING
19
149#define UCAL_UNKNOWN_ZONE_ID "Etc/Unknown"
150
155typedef void* UCalendar;
156
178
181
446
473
476
511
514
524
527
551
554
571U_STABLE UEnumeration* U_EXPORT2
573 const int32_t* rawOffset, UErrorCode* ec);
574
586U_STABLE UEnumeration* U_EXPORT2
588
605U_STABLE UEnumeration* U_EXPORT2
606ucal_openCountryTimeZones(const char* country, UErrorCode* ec);
607
624U_STABLE int32_t U_EXPORT2
625ucal_getDefaultTimeZone(UChar* result, int32_t resultCapacity, UErrorCode* ec);
626
636U_STABLE void U_EXPORT2
638
655U_STABLE int32_t U_EXPORT2
657
664U_STABLE UDate U_EXPORT2
666
690U_STABLE UCalendar* U_EXPORT2
691ucal_open(const UChar* zoneID,
692 int32_t len,
693 const char* locale,
694 UCalendarType type,
695 UErrorCode* status);
696
703U_STABLE void U_EXPORT2
705
706#if U_SHOW_CPLUSPLUS_API
707
709
720
722
723#endif
724
733U_STABLE UCalendar* U_EXPORT2
735 UErrorCode* status);
736
746U_STABLE void U_EXPORT2
748 const UChar* zoneID,
749 int32_t len,
750 UErrorCode* status);
751
762U_STABLE int32_t U_EXPORT2
764 UChar *result,
765 int32_t resultLength,
766 UErrorCode *status);
767
782
785
799U_STABLE int32_t U_EXPORT2
802 const char* locale,
803 UChar* result,
804 int32_t resultLength,
805 UErrorCode* status);
806
815U_STABLE UBool U_EXPORT2
817 UErrorCode* status );
818
839U_STABLE void U_EXPORT2
841
862U_STABLE UDate U_EXPORT2
864
898
901
931
943U_STABLE int32_t U_EXPORT2
945 UCalendarAttribute attr);
946
958U_STABLE void U_EXPORT2
961 int32_t newValue);
962
972U_STABLE const char* U_EXPORT2
973ucal_getAvailable(int32_t localeIndex);
974
983U_STABLE int32_t U_EXPORT2
985
997U_STABLE UDate U_EXPORT2
999 UErrorCode* status);
1000
1012U_STABLE void U_EXPORT2
1014 UDate dateTime,
1015 UErrorCode* status );
1016
1031U_STABLE void U_EXPORT2
1033 int32_t year,
1034 int32_t month,
1035 int32_t date,
1036 UErrorCode* status);
1037
1055U_STABLE void U_EXPORT2
1057 int32_t year,
1058 int32_t month,
1059 int32_t date,
1060 int32_t hour,
1061 int32_t minute,
1062 int32_t second,
1063 UErrorCode* status);
1064
1074U_STABLE UBool U_EXPORT2
1076 const UCalendar* cal2);
1077
1096U_STABLE void U_EXPORT2
1098 UCalendarDateFields field,
1099 int32_t amount,
1100 UErrorCode* status);
1101
1126U_STABLE void U_EXPORT2
1128 UCalendarDateFields field,
1129 int32_t amount,
1130 UErrorCode* status);
1131
1148U_STABLE int32_t U_EXPORT2
1150 UCalendarDateFields field,
1151 UErrorCode* status );
1152
1168U_STABLE void U_EXPORT2
1170 UCalendarDateFields field,
1171 int32_t value);
1172
1188U_STABLE UBool U_EXPORT2
1190 UCalendarDateFields field);
1191
1206U_STABLE void U_EXPORT2
1208 UCalendarDateFields field);
1209
1220U_STABLE void U_EXPORT2
1222
1241
1244
1259U_STABLE int32_t U_EXPORT2
1261 UCalendarDateFields field,
1262 UCalendarLimitType type,
1263 UErrorCode* status);
1264
1272U_STABLE const char * U_EXPORT2
1274
1281U_STABLE const char * U_EXPORT2
1283
1302U_STABLE int32_t U_EXPORT2
1303ucal_getCanonicalTimeZoneID(const UChar* id, int32_t len,
1304 UChar* result, int32_t resultCapacity, UBool *isSystemID, UErrorCode* status);
1312U_STABLE const char * U_EXPORT2
1313ucal_getType(const UCalendar *cal, UErrorCode* status);
1314
1331U_STABLE UEnumeration* U_EXPORT2
1333 const char* locale,
1334 UBool commonlyUsed,
1335 UErrorCode* status);
1336
1337
1365
1368
1388
1404U_STABLE int32_t U_EXPORT2
1406
1417U_STABLE UBool U_EXPORT2
1418ucal_isWeekend(const UCalendar *cal, UDate date, UErrorCode *status);
1419
1444U_STABLE int32_t U_EXPORT2
1446 UDate target,
1447 UCalendarDateFields field,
1448 UErrorCode* status);
1449
1480
1498U_STABLE UBool U_EXPORT2
1500 UDate* transition, UErrorCode* status);
1501
1526U_STABLE int32_t U_EXPORT2
1527ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
1528 UChar* winid, int32_t winidCapacity, UErrorCode* status);
1529
1558U_STABLE int32_t U_EXPORT2
1559ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region,
1560 UChar* id, int32_t idCapacity, UErrorCode* status);
1561
1562#endif /* #if !UCONFIG_NO_FORMATTING */
1563
1564#endif
"Smart pointer" class, closes a UCalendar via ucal_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
UEnumeration * ucal_openCountryTimeZones(const char *country, UErrorCode *ec)
Create an enumeration over all time zones associated with the given country.
UCalendarDateFields
Possible fields in a UCalendar.
Definition ucal.h:185
@ UCAL_HOUR_OF_DAY
Field number indicating the hour of the day.
Definition ucal.h:334
@ UCAL_EXTENDED_YEAR
Year of this calendar system, encompassing all supra-year fields.
Definition ucal.h:397
@ UCAL_ERA
Field number indicating the era, e.g., AD or BC in the Gregorian (Julian) calendar.
Definition ucal.h:191
@ UCAL_WEEK_OF_MONTH
Field number indicating the week number within the current month.
Definition ucal.h:246
@ UCAL_YEAR
Field number indicating the year.
Definition ucal.h:197
@ UCAL_DAY_OF_YEAR
Field number indicating the day number within the current year.
Definition ucal.h:262
@ UCAL_YEAR_WOY
Field number indicating the extended year corresponding to the UCAL_WEEK_OF_YEAR field.
Definition ucal.h:381
@ UCAL_MINUTE
Field number indicating the minute within the hour.
Definition ucal.h:342
@ UCAL_JULIAN_DAY
Field number indicating the modified Julian day number.
Definition ucal.h:409
@ UCAL_DATE
Field number indicating the day of the month.
Definition ucal.h:255
@ UCAL_SECOND
Field number indicating the second within the minute.
Definition ucal.h:350
@ UCAL_DAY_OF_WEEK_IN_MONTH
Field number indicating the ordinal number of the day of the week within the current month.
Definition ucal.h:303
@ UCAL_MONTH
Field number indicating the month.
Definition ucal.h:218
@ UCAL_ZONE_OFFSET
Field number indicating the raw offset from GMT in milliseconds.
Definition ucal.h:365
@ UCAL_WEEK_OF_YEAR
Field number indicating the week number within the current year.
Definition ucal.h:231
@ UCAL_MILLISECOND
Field number indicating the millisecond within the second.
Definition ucal.h:358
@ UCAL_HOUR
Field number indicating the hour of the morning or afternoon.
Definition ucal.h:325
@ UCAL_DAY_OF_MONTH
Field number indicating the day of the month.
Definition ucal.h:444
@ UCAL_DAY_OF_WEEK
Field number indicating the day of the week.
Definition ucal.h:278
@ UCAL_AM_PM
Field number indicating whether the HOUR is before or after noon.
Definition ucal.h:314
@ UCAL_FIELD_COUNT
One more than the highest normal UCalendarDateFields value.
Definition ucal.h:434
@ UCAL_IS_LEAP_MONTH
Whether or not the current month is a leap month (0 or 1).
Definition ucal.h:426
@ UCAL_DST_OFFSET
Field number indicating the daylight savings offset in milliseconds.
Definition ucal.h:372
@ UCAL_MILLISECONDS_IN_DAY
Ranges from 0 to 23:59:59.999 (regardless of DST).
Definition ucal.h:420
@ UCAL_DOW_LOCAL
Field number indicating the localized day of week.
Definition ucal.h:389
UBool ucal_inDaylightTime(const UCalendar *cal, UErrorCode *status)
Determine if a UCalendar is currently in daylight savings time.
UCalendar * ucal_clone(const UCalendar *cal, UErrorCode *status)
Open a copy of a UCalendar.
UBool ucal_getTimeZoneTransitionDate(const UCalendar *cal, UTimeZoneTransitionType type, UDate *transition, UErrorCode *status)
Get the UDate for the next/previous time zone transition relative to the calendar's current date,...
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.
const char * ucal_getAvailable(int32_t localeIndex)
Get a locale for which calendars are available.
const char * ucal_getTZDataVersion(UErrorCode *status)
Returns the timezone data version currently used by ICU.
USystemTimeZoneType
System time zone type constants used by filtering zones in ucal_openTimeZoneIDEnumeration.
Definition ucal.h:534
@ UCAL_ZONE_TYPE_CANONICAL
Canonical system zones.
Definition ucal.h:544
@ UCAL_ZONE_TYPE_ANY
Any system zones.
Definition ucal.h:539
@ UCAL_ZONE_TYPE_CANONICAL_LOCATION
Canonical system zones associated with actual locations.
Definition ucal.h:549
void ucal_setDefaultTimeZone(const UChar *zoneID, UErrorCode *ec)
Set the default time zone.
UCalendarAttribute
Types of UCalendar attributes.
Definition ucal.h:869
@ UCAL_MINIMAL_DAYS_IN_FIRST_WEEK
Minimum number of days in first week.
Definition ucal.h:884
@ UCAL_REPEATED_WALL_TIME
The behavior for handling wall time repeating multiple times at negative time zone offset transitions...
Definition ucal.h:890
@ UCAL_FIRST_DAY_OF_WEEK
First day of week.
Definition ucal.h:879
@ UCAL_SKIPPED_WALL_TIME
The behavior for handling skipped wall time at positive time zone offset transitions.
Definition ucal.h:896
@ UCAL_LENIENT
Lenient parsing.
Definition ucal.h:874
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...
UEnumeration * ucal_openTimeZoneIDEnumeration(USystemTimeZoneType zoneType, const char *region, const int32_t *rawOffset, UErrorCode *ec)
Create an enumeration over system time zone IDs with the given filter conditions.
void ucal_clear(UCalendar *calendar)
Clear all fields in a UCalendar.
UCalendarWallTimeOption
Options for handling ambiguous wall time at time zone offset transitions.
Definition ucal.h:907
@ UCAL_WALLTIME_NEXT_VALID
An ambiguous wall time to be interpreted as the next valid wall time.
Definition ucal.h:927
@ UCAL_WALLTIME_LAST
An ambiguous wall time to be interpreted as the latest.
Definition ucal.h:914
@ UCAL_WALLTIME_FIRST
An ambiguous wall time to be interpreted as the earliest.
Definition ucal.h:921
UBool ucal_equivalentTo(const UCalendar *cal1, const UCalendar *cal2)
Returns TRUE if two UCalendars are equivalent.
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...
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.
UCalendarWeekdayType
Weekday types, as returned by ucal_getDayOfWeekType().
Definition ucal.h:1341
@ UCAL_WEEKDAY
Designates a full weekday (no part of the day is included in the weekend).
Definition ucal.h:1346
@ UCAL_WEEKEND_CEASE
Designates a day that starts as the weekend and transitions to a weekday.
Definition ucal.h:1363
@ UCAL_WEEKEND
Designates a full weekend day (the entire day is included in the weekend).
Definition ucal.h:1351
@ UCAL_WEEKEND_ONSET
Designates a day that starts as a weekday and transitions to the weekend.
Definition ucal.h:1357
int32_t ucal_getLimit(const UCalendar *cal, UCalendarDateFields field, UCalendarLimitType type, UErrorCode *status)
Determine a limit for a 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.
UCalendarDaysOfWeek
Useful constant for days of week.
Definition ucal.h:457
@ UCAL_WEDNESDAY
Wednesday.
Definition ucal.h:465
@ UCAL_SATURDAY
Saturday.
Definition ucal.h:471
@ UCAL_THURSDAY
Thursday.
Definition ucal.h:467
@ UCAL_MONDAY
Monday.
Definition ucal.h:461
@ UCAL_SUNDAY
Sunday.
Definition ucal.h:459
@ UCAL_FRIDAY
Friday.
Definition ucal.h:469
@ UCAL_TUESDAY
Tuesday.
Definition ucal.h:463
UCalendarLimitType
Possible limit values for a UCalendar.
Definition ucal.h:1227
@ UCAL_ACTUAL_MAXIMUM
Actual maximum value.
Definition ucal.h:1239
@ UCAL_ACTUAL_MINIMUM
Actual minimum value.
Definition ucal.h:1237
@ UCAL_GREATEST_MINIMUM
Greatest minimum value.
Definition ucal.h:1233
@ UCAL_MINIMUM
Minimum value.
Definition ucal.h:1229
@ UCAL_MAXIMUM
Maximum value.
Definition ucal.h:1231
@ UCAL_LEAST_MAXIMUM
Leaest maximum value.
Definition ucal.h:1235
UCalendarAMPMs
Possible AM/PM values in a UCalendar.
Definition ucal.h:518
@ UCAL_AM
AM.
Definition ucal.h:520
@ UCAL_PM
PM.
Definition ucal.h:522
void ucal_add(UCalendar *cal, UCalendarDateFields field, int32_t amount, UErrorCode *status)
Add a specified signed amount to a particular field in a UCalendar.
UEnumeration * ucal_openTimeZones(UErrorCode *ec)
Create an enumeration over all time zones.
const char * ucal_getType(const UCalendar *cal, UErrorCode *status)
Get the resource keyword value string designating the calendar type for the UCalendar.
UTimeZoneTransitionType
Time zone transition types for ucal_getTimeZoneTransitionDate.
Definition ucal.h:1454
@ UCAL_TZ_TRANSITION_PREVIOUS
Get the previous transition before the current date, i.e.
Definition ucal.h:1472
@ UCAL_TZ_TRANSITION_PREVIOUS_INCLUSIVE
Get the previous transition on or before the current date, i.e.
Definition ucal.h:1478
@ UCAL_TZ_TRANSITION_NEXT
Get the next transition after the current date, i.e.
Definition ucal.h:1460
@ UCAL_TZ_TRANSITION_NEXT_INCLUSIVE
Get the next transition on or after the current date, i.e.
Definition ucal.h:1466
UCalendarType
Possible types of UCalendars.
Definition ucal.h:160
@ UCAL_GREGORIAN
Unambiguously designates the Gregorian calendar for the locale.
Definition ucal.h:176
@ UCAL_DEFAULT
A better name for UCAL_TRADITIONAL.
Definition ucal.h:171
@ UCAL_TRADITIONAL
Despite the name, UCAL_TRADITIONAL designates the locale's default calendar, which may be the Gregori...
Definition ucal.h:166
int32_t ucal_getWindowsTimeZoneID(const UChar *id, int32_t len, UChar *winid, int32_t winidCapacity, UErrorCode *status)
Converts a system time zone ID to an equivalent Windows time zone ID.
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 di...
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 zon...
int32_t ucal_getTimeZoneID(const UCalendar *cal, UChar *result, int32_t resultLength, UErrorCode *status)
Get the ID of the UCalendar's time zone.
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.
void ucal_setGregorianChange(UCalendar *cal, UDate date, UErrorCode *pErrorCode)
Sets the GregorianCalendar change date.
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_getTimeZoneIDForWindowsID(const UChar *winid, int32_t len, const char *region, UChar *id, int32_t idCapacity, UErrorCode *status)
Converts a Windows time zone ID to an equivalent system time zone ID for a region.
void ucal_setAttribute(UCalendar *cal, UCalendarAttribute attr, int32_t newValue)
Set a numeric attribute associated with a UCalendar.
const char * ucal_getLocaleByType(const UCalendar *cal, ULocDataLocaleType type, UErrorCode *status)
Get the locale for this calendar object.
int32_t ucal_countAvailable(void)
Determine how many locales have calendars available.
int32_t ucal_getDefaultTimeZone(UChar *result, int32_t resultCapacity, UErrorCode *ec)
Return the default time zone.
UDate ucal_getGregorianChange(const UCalendar *cal, UErrorCode *pErrorCode)
Gets the Gregorian Calendar change date.
void ucal_setDate(UCalendar *cal, int32_t year, int32_t month, int32_t date, UErrorCode *status)
Set a UCalendar's current date.
UBool ucal_isSet(const UCalendar *cal, UCalendarDateFields field)
Determine if a field in a UCalendar is set.
UDate ucal_getNow(void)
Get the current date and time.
UBool ucal_isWeekend(const UCalendar *cal, UDate date, UErrorCode *status)
Returns TRUE if the given UDate is in the weekend in this calendar system.
int32_t ucal_getAttribute(const UCalendar *cal, UCalendarAttribute attr)
Get a numeric attribute associated with a UCalendar.
void ucal_close(UCalendar *cal)
Close a UCalendar.
void ucal_setTimeZone(UCalendar *cal, const UChar *zoneID, int32_t len, UErrorCode *status)
Set the TimeZone used by a UCalendar.
void ucal_clearField(UCalendar *cal, UCalendarDateFields field)
Clear a field in a UCalendar.
void ucal_set(UCalendar *cal, UCalendarDateFields field, int32_t value)
Set the value of a field in a UCalendar.
UCalendarDisplayNameType
Possible formats for a UCalendar's display name.
Definition ucal.h:772
@ UCAL_STANDARD
Standard display name.
Definition ucal.h:774
@ UCAL_SHORT_DST
Short daylight savings display name.
Definition ucal.h:780
@ UCAL_SHORT_STANDARD
Short standard display name.
Definition ucal.h:776
@ UCAL_DST
Daylight savings display name.
Definition ucal.h:778
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.
UCalendarMonths
Possible months in a UCalendar.
Definition ucal.h:480
@ UCAL_DECEMBER
December.
Definition ucal.h:504
@ UCAL_MAY
May.
Definition ucal.h:490
@ UCAL_UNDECIMBER
Value of the UCAL_MONTH field indicating the thirteenth month of the year.
Definition ucal.h:509
@ UCAL_APRIL
April.
Definition ucal.h:488
@ UCAL_NOVEMBER
November.
Definition ucal.h:502
@ UCAL_JUNE
June.
Definition ucal.h:492
@ UCAL_AUGUST
August.
Definition ucal.h:496
@ UCAL_JULY
July.
Definition ucal.h:494
@ UCAL_SEPTEMBER
September.
Definition ucal.h:498
@ UCAL_JANUARY
January.
Definition ucal.h:482
@ UCAL_FEBRUARY
February.
Definition ucal.h:484
@ UCAL_MARCH
March.
Definition ucal.h:486
@ UCAL_OCTOBER
October.
Definition ucal.h:500
UCalendar * ucal_open(const UChar *zoneID, int32_t len, const char *locale, UCalendarType type, UErrorCode *status)
Open a UCalendar.
int32_t ucal_getFieldDifference(UCalendar *cal, UDate target, UCalendarDateFields field, UErrorCode *status)
Return the difference between the target time and the time this calendar object is currently set to.
void * UCalendar
A calendar.
Definition ucal.h:155
C API: String Enumeration.
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition uenum.h:43
C API: Locale.
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition uloc.h:338
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:353
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:111
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
double UDate
Date and Time data type.
Definition utypes.h:203
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137