ICU 56.1: ucal.h Source File

ICU 56.1 56.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

ucal.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 1996-2015, International Business Machines Corporation and
4 * others. All Rights Reserved.
5 *******************************************************************************
6 */
7
8 #ifndef UCAL_H
9 #define UCAL_H
10
11 #include "unicode/utypes.h"
12 #include "unicode/uenum.h"
13 #include "unicode/uloc.h"
14 #include "unicode/localpointer.h"
15
16 #if !UCONFIG_NO_FORMATTING
17
147 #define UCAL_UNKNOWN_ZONE_ID "Etc/Unknown"
148
153 typedef void* UCalendar;
154
158 enum UCalendarType {
164 UCAL_TRADITIONAL,
169 UCAL_DEFAULT = UCAL_TRADITIONAL,
174 UCAL_GREGORIAN
175 };
176
178 typedef enum UCalendarType UCalendarType;
179
183 enum UCalendarDateFields {
189 UCAL_ERA,
190
195 UCAL_YEAR,
196
216 UCAL_MONTH,
217
229 UCAL_WEEK_OF_YEAR,
230
244 UCAL_WEEK_OF_MONTH,
245
253 UCAL_DATE,
254
260 UCAL_DAY_OF_YEAR,
261
276 UCAL_DAY_OF_WEEK,
277
301 UCAL_DAY_OF_WEEK_IN_MONTH,
302
312 UCAL_AM_PM,
313
323 UCAL_HOUR,
324
332 UCAL_HOUR_OF_DAY,
333
340 UCAL_MINUTE,
341
348 UCAL_SECOND,
349
356 UCAL_MILLISECOND,
357
363 UCAL_ZONE_OFFSET,
364
370 UCAL_DST_OFFSET,
371
379 UCAL_YEAR_WOY,
380
387 UCAL_DOW_LOCAL,
388
395 UCAL_EXTENDED_YEAR,
396
407 UCAL_JULIAN_DAY,
408
418 UCAL_MILLISECONDS_IN_DAY,
419
424 UCAL_IS_LEAP_MONTH,
425
430 UCAL_FIELD_COUNT,
431
440 UCAL_DAY_OF_MONTH=UCAL_DATE
441 };
442
444 typedef enum UCalendarDateFields UCalendarDateFields;
453 enum UCalendarDaysOfWeek {
455 UCAL_SUNDAY = 1,
457 UCAL_MONDAY,
459 UCAL_TUESDAY,
461 UCAL_WEDNESDAY,
463 UCAL_THURSDAY,
465 UCAL_FRIDAY,
467 UCAL_SATURDAY
468 };
469
471 typedef enum UCalendarDaysOfWeek UCalendarDaysOfWeek;
472
476 enum UCalendarMonths {
478 UCAL_JANUARY,
480 UCAL_FEBRUARY,
482 UCAL_MARCH,
484 UCAL_APRIL,
486 UCAL_MAY,
488 UCAL_JUNE,
490 UCAL_JULY,
492 UCAL_AUGUST,
494 UCAL_SEPTEMBER,
496 UCAL_OCTOBER,
498 UCAL_NOVEMBER,
500 UCAL_DECEMBER,
505 UCAL_UNDECIMBER
506 };
507
509 typedef enum UCalendarMonths UCalendarMonths;
510
514 enum UCalendarAMPMs {
516 UCAL_AM,
518 UCAL_PM
519 };
520
522 typedef enum UCalendarAMPMs UCalendarAMPMs;
523
530 enum USystemTimeZoneType {
535 UCAL_ZONE_TYPE_ANY,
540 UCAL_ZONE_TYPE_CANONICAL,
545 UCAL_ZONE_TYPE_CANONICAL_LOCATION
546 };
547
549 typedef enum USystemTimeZoneType USystemTimeZoneType;
550
567 U_STABLE UEnumeration* U_EXPORT2
568 ucal_openTimeZoneIDEnumeration(USystemTimeZoneType zoneType, const char* region,
569 const int32_t* rawOffset, UErrorCode* ec);
570
582 U_STABLE UEnumeration* U_EXPORT2
583 ucal_openTimeZones(UErrorCode* ec);
584
601 U_STABLE UEnumeration* U_EXPORT2
602 ucal_openCountryTimeZones(const char* country, UErrorCode* ec);
603
620 U_STABLE int32_t U_EXPORT2
621 ucal_getDefaultTimeZone(UChar* result, int32_t resultCapacity, UErrorCode* ec);
622
632 U_STABLE void U_EXPORT2
633 ucal_setDefaultTimeZone(const UChar* zoneID, UErrorCode* ec);
634
651 U_STABLE int32_t U_EXPORT2
652 ucal_getDSTSavings(const UChar* zoneID, UErrorCode* ec);
653
660 U_STABLE UDate U_EXPORT2
661 ucal_getNow(void);
662
686 U_STABLE UCalendar* U_EXPORT2
687 ucal_open(const UChar* zoneID,
688 int32_t len,
689 const char* locale,
690 UCalendarType type,
691 UErrorCode* status);
692
699 U_STABLE void U_EXPORT2
700 ucal_close(UCalendar *cal);
701
702 #if U_SHOW_CPLUSPLUS_API
703
704 U_NAMESPACE_BEGIN
705
715 U_DEFINE_LOCAL_OPEN_POINTER(LocalUCalendarPointer, UCalendar, ucal_close);
716
717 U_NAMESPACE_END
718
719 #endif
720
729 U_STABLE UCalendar* U_EXPORT2
730 ucal_clone(const UCalendar* cal,
731 UErrorCode* status);
732
742 U_STABLE void U_EXPORT2
743 ucal_setTimeZone(UCalendar* cal,
744 const UChar* zoneID,
745 int32_t len,
746 UErrorCode* status);
747
758 U_STABLE int32_t U_EXPORT2
759 ucal_getTimeZoneID(const UCalendar *cal,
760 UChar *result,
761 int32_t resultLength,
762 UErrorCode *status);
763
768 enum UCalendarDisplayNameType {
770 UCAL_STANDARD,
772 UCAL_SHORT_STANDARD,
774 UCAL_DST,
776 UCAL_SHORT_DST
777 };
778
780 typedef enum UCalendarDisplayNameType UCalendarDisplayNameType;
781
795 U_STABLE int32_t U_EXPORT2
796 ucal_getTimeZoneDisplayName(const UCalendar* cal,
797 UCalendarDisplayNameType type,
798 const char* locale,
799 UChar* result,
800 int32_t resultLength,
801 UErrorCode* status);
802
811 U_STABLE UBool U_EXPORT2
812 ucal_inDaylightTime(const UCalendar* cal,
813 UErrorCode* status );
814
835 U_STABLE void U_EXPORT2
836 ucal_setGregorianChange(UCalendar *cal, UDate date, UErrorCode *pErrorCode);
837
858 U_STABLE UDate U_EXPORT2
859 ucal_getGregorianChange(const UCalendar *cal, UErrorCode *pErrorCode);
860
865 enum UCalendarAttribute {
870 UCAL_LENIENT,
875 UCAL_FIRST_DAY_OF_WEEK,
880 UCAL_MINIMAL_DAYS_IN_FIRST_WEEK,
886 UCAL_REPEATED_WALL_TIME,
892 UCAL_SKIPPED_WALL_TIME
893 };
894
896 typedef enum UCalendarAttribute UCalendarAttribute;
897
903 enum UCalendarWallTimeOption {
910 UCAL_WALLTIME_LAST,
917 UCAL_WALLTIME_FIRST,
923 UCAL_WALLTIME_NEXT_VALID
924 };
926 typedef enum UCalendarWallTimeOption UCalendarWallTimeOption;
927
939 U_STABLE int32_t U_EXPORT2
940 ucal_getAttribute(const UCalendar* cal,
941 UCalendarAttribute attr);
942
954 U_STABLE void U_EXPORT2
955 ucal_setAttribute(UCalendar* cal,
956 UCalendarAttribute attr,
957 int32_t newValue);
958
968 U_STABLE const char* U_EXPORT2
969 ucal_getAvailable(int32_t localeIndex);
970
979 U_STABLE int32_t U_EXPORT2
980 ucal_countAvailable(void);
981
993 U_STABLE UDate U_EXPORT2
994 ucal_getMillis(const UCalendar* cal,
995 UErrorCode* status);
996
1008 U_STABLE void U_EXPORT2
1009 ucal_setMillis(UCalendar* cal,
1010 UDate dateTime,
1011 UErrorCode* status );
1012
1027 U_STABLE void U_EXPORT2
1028 ucal_setDate(UCalendar* cal,
1029 int32_t year,
1030 int32_t month,
1031 int32_t date,
1032 UErrorCode* status);
1033
1051 U_STABLE void U_EXPORT2
1052 ucal_setDateTime(UCalendar* cal,
1053 int32_t year,
1054 int32_t month,
1055 int32_t date,
1056 int32_t hour,
1057 int32_t minute,
1058 int32_t second,
1059 UErrorCode* status);
1060
1070 U_STABLE UBool U_EXPORT2
1071 ucal_equivalentTo(const UCalendar* cal1,
1072 const UCalendar* cal2);
1073
1092 U_STABLE void U_EXPORT2
1093 ucal_add(UCalendar* cal,
1094 UCalendarDateFields field,
1095 int32_t amount,
1096 UErrorCode* status);
1097
1122 U_STABLE void U_EXPORT2
1123 ucal_roll(UCalendar* cal,
1124 UCalendarDateFields field,
1125 int32_t amount,
1126 UErrorCode* status);
1127
1144 U_STABLE int32_t U_EXPORT2
1145 ucal_get(const UCalendar* cal,
1146 UCalendarDateFields field,
1147 UErrorCode* status );
1148
1164 U_STABLE void U_EXPORT2
1165 ucal_set(UCalendar* cal,
1166 UCalendarDateFields field,
1167 int32_t value);
1168
1184 U_STABLE UBool U_EXPORT2
1185 ucal_isSet(const UCalendar* cal,
1186 UCalendarDateFields field);
1187
1202 U_STABLE void U_EXPORT2
1203 ucal_clearField(UCalendar* cal,
1204 UCalendarDateFields field);
1205
1216 U_STABLE void U_EXPORT2
1217 ucal_clear(UCalendar* calendar);
1218
1223 enum UCalendarLimitType {
1225 UCAL_MINIMUM,
1227 UCAL_MAXIMUM,
1229 UCAL_GREATEST_MINIMUM,
1231 UCAL_LEAST_MAXIMUM,
1233 UCAL_ACTUAL_MINIMUM,
1235 UCAL_ACTUAL_MAXIMUM
1236 };
1237
1239 typedef enum UCalendarLimitType UCalendarLimitType;
1240
1255 U_STABLE int32_t U_EXPORT2
1256 ucal_getLimit(const UCalendar* cal,
1257 UCalendarDateFields field,
1258 UCalendarLimitType type,
1259 UErrorCode* status);
1260
1268 U_STABLE const char * U_EXPORT2
1269 ucal_getLocaleByType(const UCalendar *cal, ULocDataLocaleType type, UErrorCode* status);
1270
1277 U_STABLE const char * U_EXPORT2
1278 ucal_getTZDataVersion(UErrorCode* status);
1279
1298 U_STABLE int32_t U_EXPORT2
1299 ucal_getCanonicalTimeZoneID(const UChar* id, int32_t len,
1300 UChar* result, int32_t resultCapacity, UBool *isSystemID, UErrorCode* status);
1308 U_STABLE const char * U_EXPORT2
1309 ucal_getType(const UCalendar *cal, UErrorCode* status);
1310
1327 U_STABLE UEnumeration* U_EXPORT2
1328 ucal_getKeywordValuesForLocale(const char* key,
1329 const char* locale,
1330 UBool commonlyUsed,
1331 UErrorCode* status);
1332
1333
1337 enum UCalendarWeekdayType {
1342 UCAL_WEEKDAY,
1347 UCAL_WEEKEND,
1353 UCAL_WEEKEND_ONSET,
1359 UCAL_WEEKEND_CEASE
1360 };
1361
1363 typedef enum UCalendarWeekdayType UCalendarWeekdayType;
1364
1382 U_STABLE UCalendarWeekdayType U_EXPORT2
1383 ucal_getDayOfWeekType(const UCalendar *cal, UCalendarDaysOfWeek dayOfWeek, UErrorCode* status);
1384
1400 U_STABLE int32_t U_EXPORT2
1401 ucal_getWeekendTransition(const UCalendar *cal, UCalendarDaysOfWeek dayOfWeek, UErrorCode *status);
1402
1413 U_STABLE UBool U_EXPORT2
1414 ucal_isWeekend(const UCalendar *cal, UDate date, UErrorCode *status);
1415
1440 U_STABLE int32_t U_EXPORT2
1441 ucal_getFieldDifference(UCalendar* cal,
1442 UDate target,
1443 UCalendarDateFields field,
1444 UErrorCode* status);
1445
1450 enum UTimeZoneTransitionType {
1456 UCAL_TZ_TRANSITION_NEXT,
1462 UCAL_TZ_TRANSITION_NEXT_INCLUSIVE,
1468 UCAL_TZ_TRANSITION_PREVIOUS,
1474 UCAL_TZ_TRANSITION_PREVIOUS_INCLUSIVE
1475 };
1476
1477 typedef enum UTimeZoneTransitionType UTimeZoneTransitionType;
1494 U_STABLE UBool U_EXPORT2
1495 ucal_getTimeZoneTransitionDate(const UCalendar* cal, UTimeZoneTransitionType type,
1496 UDate* transition, UErrorCode* status);
1497
1522 U_STABLE int32_t U_EXPORT2
1523 ucal_getWindowsTimeZoneID(const UChar* id, int32_t len,
1524 UChar* winid, int32_t winidCapacity, UErrorCode* status);
1525
1554 U_STABLE int32_t U_EXPORT2
1555 ucal_getTimeZoneIDForWindowsID(const UChar* winid, int32_t len, const char* region,
1556 UChar* id, int32_t idCapacity, UErrorCode* status);
1557
1558 #endif /* #if !UCONFIG_NO_FORMATTING */
1559
1560 #endif
ucal_clone
UCalendar * ucal_clone(const UCalendar *cal, UErrorCode *status)
Open a copy of a UCalendar.
UCAL_DEFAULT
A better name for UCAL_TRADITIONAL.
Definition: ucal.h:169
UCalendar
void * UCalendar
A calendar.
Definition: ucal.h:153
UCAL_DAY_OF_YEAR
Field number indicating the day number within the current year.
Definition: ucal.h:260
UCAL_AUGUST
August.
Definition: ucal.h:492
UCAL_MAY
May.
Definition: ucal.h:486
UCAL_SHORT_STANDARD
Short standard display name.
Definition: ucal.h:772
UCalendarDateFields
UCalendarDateFields
Possible fields in a UCalendar.
Definition: ucal.h:183
ucal_setGregorianChange
void ucal_setGregorianChange(UCalendar *cal, UDate date, UErrorCode *pErrorCode)
Sets the GregorianCalendar change date.
UCAL_DATE
Field number indicating the day of the month.
Definition: ucal.h:253
ucal_clear
void ucal_clear(UCalendar *calendar)
Clear all fields in a UCalendar.
UCAL_MILLISECONDS_IN_DAY
Ranges from 0 to 23:59:59.999 (regardless of DST).
Definition: ucal.h:418
UCAL_MINIMAL_DAYS_IN_FIRST_WEEK
Minimum number of days in first week.
Definition: ucal.h:880
ucal_getTimeZoneIDForWindowsID
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.
ucal_countAvailable
int32_t ucal_countAvailable(void)
Determine how many locales have calendars available.
UCAL_LENIENT
Lenient parsing.
Definition: ucal.h:870
UCAL_AM
AM.
Definition: ucal.h:516
UCAL_ERA
Field number indicating the era, e.g., AD or BC in the Gregorian (Julian) calendar.
Definition: ucal.h:189
UCAL_WEEKEND_CEASE
Designates a day that starts as the weekend and transitions to a weekday.
Definition: ucal.h:1359
UCAL_TZ_TRANSITION_NEXT_INCLUSIVE
Get the next transition on or after the current date, i.e.
Definition: ucal.h:1462
ucal_inDaylightTime
UBool ucal_inDaylightTime(const UCalendar *cal, UErrorCode *status)
Determine if a UCalendar is currently in daylight savings time.
UCAL_WEEKDAY
Designates a full weekday (no part of the day is included in the weekend).
Definition: ucal.h:1342
UCAL_UNDECIMBER
Value of the UCAL_MONTH field indicating the thirteenth month of the year.
Definition: ucal.h:505
ucal_get
int32_t ucal_get(const UCalendar *cal, UCalendarDateFields field, UErrorCode *status)
Get the current value of a field from a UCalendar.
ucal_getLimit
int32_t ucal_getLimit(const UCalendar *cal, UCalendarDateFields field, UCalendarLimitType type, UErrorCode *status)
Determine a limit for a field in a UCalendar.
ucal_isSet
UBool ucal_isSet(const UCalendar *cal, UCalendarDateFields field)
Determine if a field in a UCalendar is set.
UCAL_TZ_TRANSITION_NEXT
Get the next transition after the current date, i.e.
Definition: ucal.h:1456
UCAL_MAXIMUM
Maximum value.
Definition: ucal.h:1227
UCAL_JUNE
June.
Definition: ucal.h:488
UCAL_LEAST_MAXIMUM
Leaest maximum value.
Definition: ucal.h:1231
UDate
double UDate
Date and Time data type.
Definition: utypes.h:201
UCAL_WEEK_OF_MONTH
Field number indicating the week number within the current month.
Definition: ucal.h:244
UEnumeration
struct UEnumeration UEnumeration
structure representing an enumeration object instance
Definition: uenum.h:39
UCAL_MILLISECOND
Field number indicating the millisecond within the second.
Definition: ucal.h:356
UCAL_EXTENDED_YEAR
Year of this calendar system, encompassing all supra-year fields.
Definition: ucal.h:395
UCAL_STANDARD
Standard display name.
Definition: ucal.h:770
ucal_isWeekend
UBool ucal_isWeekend(const UCalendar *cal, UDate date, UErrorCode *status)
Returns TRUE if the given UDate is in the weekend in this calendar system.
UCAL_ACTUAL_MINIMUM
Actual minimum value.
Definition: ucal.h:1233
UCAL_FRIDAY
Friday.
Definition: ucal.h:465
ucal_getTimeZoneTransitionDate
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...
ucal_getAvailable
const char * ucal_getAvailable(int32_t localeIndex)
Get a locale for which calendars are available.
UCAL_MINIMUM
Minimum value.
Definition: ucal.h:1225
ucal_getDayOfWeekType
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...
ucal_equivalentTo
UBool ucal_equivalentTo(const UCalendar *cal1, const UCalendar *cal2)
Returns TRUE if two UCalendars are equivalent.
UCAL_WEDNESDAY
Wednesday.
Definition: ucal.h:461
UCAL_TUESDAY
Tuesday.
Definition: ucal.h:459
UCalendarWeekdayType
UCalendarWeekdayType
Weekday types, as returned by ucal_getDayOfWeekType().
Definition: ucal.h:1337
UCAL_SATURDAY
Saturday.
Definition: ucal.h:467
UCAL_MARCH
March.
Definition: ucal.h:482
UCAL_YEAR_WOY
Field number indicating the extended year corresponding to the UCAL_WEEK_OF_YEAR field.
Definition: ucal.h:379
UCAL_DAY_OF_MONTH
Field number indicating the day of the month.
Definition: ucal.h:440
LocalUCalendarPointer
"Smart pointer" class, closes a UCalendar via ucal_close().
UCalendarAttribute
UCalendarAttribute
Types of UCalendar attributes.
Definition: ucal.h:865
UTimeZoneTransitionType
UTimeZoneTransitionType
Time zone transition types for ucal_getTimeZoneTransitionDate.
Definition: ucal.h:1450
UCAL_TZ_TRANSITION_PREVIOUS
Get the previous transition before the current date, i.e.
Definition: ucal.h:1468
UCAL_WALLTIME_FIRST
An ambiguous wall time to be interpreted as the earliest.
Definition: ucal.h:917
UCAL_SUNDAY
Sunday.
Definition: ucal.h:455
UCalendarWallTimeOption
UCalendarWallTimeOption
Options for handling ambiguous wall time at time zone offset transitions.
Definition: ucal.h:903
UCAL_AM_PM
Field number indicating whether the HOUR is before or after noon.
Definition: ucal.h:312
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:301
UCAL_FIRST_DAY_OF_WEEK
First day of week.
Definition: ucal.h:875
ucal_getTimeZoneID
int32_t ucal_getTimeZoneID(const UCalendar *cal, UChar *result, int32_t resultLength, UErrorCode *status)
Get the ID of the UCalendar's time zone.
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
UCAL_FEBRUARY
February.
Definition: ucal.h:480
ucal_getFieldDifference
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...
UCAL_OCTOBER
October.
Definition: ucal.h:496
UCAL_SHORT_DST
Short daylight savings display name.
Definition: ucal.h:776
ucal_getDSTSavings
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...
UCAL_GREATEST_MINIMUM
Greatest minimum value.
Definition: ucal.h:1229
UCalendarDaysOfWeek
UCalendarDaysOfWeek
Useful constant for days of week.
Definition: ucal.h:453
UCAL_NOVEMBER
November.
Definition: ucal.h:498
ucal_getLocaleByType
const char * ucal_getLocaleByType(const UCalendar *cal, ULocDataLocaleType type, UErrorCode *status)
Get the locale for this calendar object.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:535
UCAL_DST
Daylight savings display name.
Definition: ucal.h:774
UCAL_TRADITIONAL
Despite the name, UCAL_TRADITIONAL designates the locale's default calendar, which may be the Gregori...
Definition: ucal.h:164
ucal_getKeywordValuesForLocale
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...
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
UCAL_JULY
July.
Definition: ucal.h:490
ucal_openTimeZones
UEnumeration * ucal_openTimeZones(UErrorCode *ec)
Create an enumeration over all time zones.
UCAL_ZONE_TYPE_CANONICAL_LOCATION
Canonical system zones associated with actual locations.
Definition: ucal.h:545
UCAL_MONDAY
Monday.
Definition: ucal.h:457
UCAL_HOUR
Field number indicating the hour of the morning or afternoon.
Definition: ucal.h:323
UCAL_MINUTE
Field number indicating the minute within the hour.
Definition: ucal.h:340
ucal_openCountryTimeZones
UEnumeration * ucal_openCountryTimeZones(const char *country, UErrorCode *ec)
Create an enumeration over all time zones associated with the given country.
ucal_open
UCalendar * ucal_open(const UChar *zoneID, int32_t len, const char *locale, UCalendarType type, UErrorCode *status)
Open a UCalendar.
ucal_getAttribute
int32_t ucal_getAttribute(const UCalendar *cal, UCalendarAttribute attr)
Get a numeric attribute associated with a UCalendar.
UCAL_APRIL
April.
Definition: ucal.h:484
ucal_setAttribute
void ucal_setAttribute(UCalendar *cal, UCalendarAttribute attr, int32_t newValue)
Set a numeric attribute associated with a UCalendar.
UCAL_ZONE_TYPE_ANY
Any system zones.
Definition: ucal.h:535
UCAL_DAY_OF_WEEK
Field number indicating the day of the week.
Definition: ucal.h:276
ucal_set
void ucal_set(UCalendar *cal, UCalendarDateFields field, int32_t value)
Set the value of a field in a UCalendar.
UCAL_IS_LEAP_MONTH
Whether or not the current month is a leap month (0 or 1).
Definition: ucal.h:424
UCAL_SKIPPED_WALL_TIME
The behavior for handling skipped wall time at positive time zone offset transitions.
Definition: ucal.h:892
UCAL_YEAR
Field number indicating the year.
Definition: ucal.h:195
UCAL_TZ_TRANSITION_PREVIOUS_INCLUSIVE
Get the previous transition on or before the current date, i.e.
Definition: ucal.h:1474
ucal_close
void ucal_close(UCalendar *cal)
Close a UCalendar.
ucal_getTZDataVersion
const char * ucal_getTZDataVersion(UErrorCode *status)
Returns the timezone data version currently used by ICU.
ucal_setMillis
void ucal_setMillis(UCalendar *cal, UDate dateTime, UErrorCode *status)
Set a UCalendar's current time in millis.
ucal_getWeekendTransition
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...
UCAL_ACTUAL_MAXIMUM
Actual maximum value.
Definition: ucal.h:1235
UChar
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:312
UCalendarType
UCalendarType
Possible types of UCalendars.
Definition: ucal.h:158
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
ucal_setDate
void ucal_setDate(UCalendar *cal, int32_t year, int32_t month, int32_t date, UErrorCode *status)
Set a UCalendar's current date.
UCAL_THURSDAY
Thursday.
Definition: ucal.h:463
UCAL_SEPTEMBER
September.
Definition: ucal.h:494
ucal_setDateTime
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.
UCAL_WALLTIME_NEXT_VALID
An ambiguous wall time to be interpreted as the next valid wall time.
Definition: ucal.h:923
UCAL_ZONE_TYPE_CANONICAL
Canonical system zones.
Definition: ucal.h:540
USystemTimeZoneType
USystemTimeZoneType
System time zone type constants used by filtering zones in ucal_openTimeZoneIDEnumeration.
Definition: ucal.h:530
UCAL_DOW_LOCAL
Field number indicating the localized day of week.
Definition: ucal.h:387
UCAL_WEEKEND
Designates a full weekend day (the entire day is included in the weekend).
Definition: ucal.h:1347
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
ucal_add
void ucal_add(UCalendar *cal, UCalendarDateFields field, int32_t amount, UErrorCode *status)
Add a specified signed amount to a particular field in a UCalendar.
ucal_setDefaultTimeZone
void ucal_setDefaultTimeZone(const UChar *zoneID, UErrorCode *ec)
Set the default time zone.
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested...
Definition: uloc.h:336
UCAL_GREGORIAN
Unambiguously designates the Gregorian calendar for the locale.
Definition: ucal.h:174
uenum.h
C API: String Enumeration.
ucal_getDefaultTimeZone
int32_t ucal_getDefaultTimeZone(UChar *result, int32_t resultCapacity, UErrorCode *ec)
Return the default time zone.
UCAL_JANUARY
January.
Definition: ucal.h:478
ucal_getWindowsTimeZoneID
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.
ucal_getType
const char * ucal_getType(const UCalendar *cal, UErrorCode *status)
Get the resource keyword value string designating the calendar type for the UCalendar.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UCAL_REPEATED_WALL_TIME
The behavior for handling wall time repeating multiple times at negative time zone offset transitions...
Definition: ucal.h:886
ucal_getTimeZoneDisplayName
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.
UCAL_WEEKEND_ONSET
Designates a day that starts as a weekday and transitions to the weekend.
Definition: ucal.h:1353
UCAL_DST_OFFSET
Field number indicating the daylight savings offset in milliseconds.
Definition: ucal.h:370
UCAL_SECOND
Field number indicating the second within the minute.
Definition: ucal.h:348
UCAL_FIELD_COUNT
Field count.
Definition: ucal.h:430
ucal_roll
void ucal_roll(UCalendar *cal, UCalendarDateFields field, int32_t amount, UErrorCode *status)
Add a specified signed amount to a particular field in a UCalendar.
UCalendarDisplayNameType
UCalendarDisplayNameType
Possible formats for a UCalendar's display name.
Definition: ucal.h:768
UCAL_ZONE_OFFSET
Field number indicating the raw offset from GMT in milliseconds.
Definition: ucal.h:363
ucal_setTimeZone
void ucal_setTimeZone(UCalendar *cal, const UChar *zoneID, int32_t len, UErrorCode *status)
Set the TimeZone used by a UCalendar.
ucal_getCanonicalTimeZoneID
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...
UCalendarAMPMs
UCalendarAMPMs
Possible AM/PM values in a UCalendar.
Definition: ucal.h:514
UCAL_WEEK_OF_YEAR
Field number indicating the week number within the current year.
Definition: ucal.h:229
UCalendarLimitType
UCalendarLimitType
Possible limit values for a UCalendar.
Definition: ucal.h:1223
ucal_getNow
UDate ucal_getNow(void)
Get the current date and time.
UCalendarMonths
UCalendarMonths
Possible months in a UCalendar.
Definition: ucal.h:476
UCAL_DECEMBER
December.
Definition: ucal.h:500
ucal_openTimeZoneIDEnumeration
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. ...
UCAL_WALLTIME_LAST
An ambiguous wall time to be interpreted as the latest.
Definition: ucal.h:910
UCAL_HOUR_OF_DAY
Field number indicating the hour of the day.
Definition: ucal.h:332
UCAL_JULIAN_DAY
Field number indicating the modified Julian day number.
Definition: ucal.h:407
ucal_getMillis
UDate ucal_getMillis(const UCalendar *cal, UErrorCode *status)
Get a UCalendar's current time in millis.
ucal_getGregorianChange
UDate ucal_getGregorianChange(const UCalendar *cal, UErrorCode *pErrorCode)
Gets the Gregorian Calendar change date.
ucal_clearField
void ucal_clearField(UCalendar *cal, UCalendarDateFields field)
Clear a field in a UCalendar.
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:109
UBool
int8_t UBool
The ICU boolean type.
Definition: umachine.h:234
UCAL_MONTH
Field number indicating the month.
Definition: ucal.h:216
UCAL_PM
PM.
Definition: ucal.h:518
uloc.h
C API: Locale.