Movatterモバイル変換

Enum for use with getDisplayName.

Stable:

ICU 2.4

Definition at line675 of filetimezone.h.

Stable:

ICU 2.0

Default constructor.

ID is initialized to the empty string.

Stable:

ICU 2.0

Construct aTimeZone with a given ID.

Parameters

id	a system time zone ID

Stable:

ICU 2.0

Copy constructor.

Parameters

source

the object to be copied.

Stable:

ICU 2.0

Sets the default time zone (i.e., what's returned bycreateDefault()) to be the specified time zone.

If nullptr is specified for the time zone, the default time zone is set to the default host time zone. This call adopts theTimeZone object passed in; the client is no longer responsible for deleting it.

Parameters

zone	A pointer to the newTimeZone object to use as the default.

Stable:

ICU 2.0

ClonesTimeZone objects polymorphically.

Clients are responsible for deleting theTimeZone object cloned.

Returns

A new copy of thisTimeZone object.

Stable:

ICU 2.0

Implemented inicu::BasicTimeZone,icu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Returns the number of IDs in the equivalency group that includes the given ID.

An equivalency group contains zones that have the same GMT offset and rules.

The returned count includes the given ID; it is always >= 1. The given ID must be a system time zone. If it is not, returns zero.

Parameters

id	a system time zone ID

Returns

the number of zones in the equivalency group containing 'id', or zero if 'id' is not a valid system ID

See also

getEquivalentID

Stable:

ICU 2.0

Creates a new copy of the defaultTimeZone for this host.

Unless the default time zone has already been set usingadoptDefault() orsetDefault(), the default is determined by querying the host system configuration. If the host system detection routines fail, or if they specify aTimeZone orTimeZone offset which is not recognized, then the specialTimeZone "Etc/Unknown" is instantiated and made the default.

Returns

A defaultTimeZone. Clients are responsible for deleting the time zone object returned.

See also

getUnknown

Stable:

ICU 2.0

Returns an enumeration over all recognized time zone IDs.

(i.e., all strings thatcreateTimeZone() accepts)

Returns

an enumeration object, owned by the caller.

Deprecated:

ICU 70 UsecreateEnumeration(UErrorCode&) instead.

Returns an enumeration over time zone IDs associated with the given region.

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

Parameters

region

The ISO 3166 two-letter country code, or nullptr to retrieve zones not affiliated with any region.

Returns

an enumeration object, owned by the caller

Deprecated:

ICU 70 UsecreateEnumerationForRegion(const char*,UErrorCode&) instead.

Returns an enumeration over time zone IDs with a given raw offset from GMT.

There may be several times zones with the same GMT offset that differ in the way they handle daylight savings time. For example, the state of Arizona doesn't observe daylight savings time. If you ask for the time zone IDs corresponding to GMT-7:00, you'll get back an enumeration over two time zone IDs: "America/Denver," which corresponds to Mountain Standard Time in the winter and Mountain Daylight Time in the summer, and "America/Phoenix", which corresponds to Mountain Standard Time year-round, even in the summer.

Parameters

rawOffset

an offset from GMT in milliseconds, ignoring the effect of daylight savings time, if any

Returns

an enumeration object, owned by the caller

Deprecated:

ICU 70 UsecreateEnumerationForRawOffset(int32_t,UErrorCode&) instead.

Returns an enumeration over all recognized time zone IDs.

(i.e., all strings thatcreateTimeZone() accepts)

Parameters

status

Receives the status.

Returns

an enumeration object, owned by the caller.

Stable:

ICU 70

Returns an enumeration over time zone IDs with a given raw offset from GMT.

There may be several times zones with the same GMT offset that differ in the way they handle daylight savings time. For example, the state of Arizona doesn't observe daylight savings time. If you ask for the time zone IDs corresponding to GMT-7:00, you'll get back an enumeration over two time zone IDs: "America/Denver," which corresponds to Mountain Standard Time in the winter and Mountain Daylight Time in the summer, and "America/Phoenix", which corresponds to Mountain Standard Time year-round, even in the summer.

Parameters

rawOffset	an offset from GMT in milliseconds, ignoring the effect of daylight savings time, if any
status	Receives the status.

Returns

an enumeration object, owned by the caller

Stable:

ICU 70

Returns an enumeration over time zone IDs associated with the given region.

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

Parameters

region	The ISO 3166 two-letter country code, or nullptr to retrieve zones not affiliated with any region.
status	Receives the status.

Returns

an enumeration object, owned by the caller

Stable:

ICU 70

Creates aTimeZone for the given ID.

Parameters

ID	the ID for aTimeZone, such as "America/Los_Angeles", or a custom ID such as "GMT-8:00".

Returns

the specifiedTimeZone, or a mutable clone ofgetUnknown() if the given ID cannot be understood or if the given ID is "Etc/Unknown". The return result is guaranteed to be non-nullptr. If you require that the specific zone asked for be returned, compare the result withgetUnknown() or check the ID of the return result.

Stable:

ICU 2.0

Returns an enumeration over system time zone IDs with the given filter conditions.

Parameters

zoneType	The system time zone type.
region	The ISO 3166 two-letter country code or UN M.49 three-digit area code. When nullptr, no filtering done by region.
rawOffset	An offset from GMT in milliseconds, ignoring the effect of daylight savings time, if any. When nullptr, no filtering done by zone offset.
ec	Output param to filled in with a success or an error.

Returns

an enumeration object, owned by the caller.

Stable:

ICU 4.8

Creates an instance ofTimeZone detected from the current host system configuration.

If the host system detection routines fail, or if they specify aTimeZone orTimeZone offset which is not recognized, then the specialTimeZone "Etc/Unknown" is returned.

Note that ICU4C does not change the default time zone unlessTimeZone::adoptDefault(TimeZone*) orTimeZone::setDefault(const TimeZone&) is explicitly called by a user. This method does not update the current ICU's default, and may return a differentTimeZone from the one returned byTimeZone::createDefault().

This function is not thread safe.

Returns

A new instance ofTimeZone detected from the current host system configuration.

See also

adoptDefault

setDefault

createDefault

getUnknown

Stable:

ICU 55

If the locale contains the timezone keyword, creates a copy of thatTimeZone.

Otherwise, create the default timezone.

Parameters

locale

a locale which may contains 'timezone' keyword/value.

Returns

ATimeZone. Clients are responsible for deleting the time zone object returned.

Internal:

Do not use. This API is for internal use only.

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

Parameters

id	The input time zone ID to be canonicalized.
canonicalID	Receives the canonical system time zone ID or the custom time zone ID in normalized format.
isSystemID	Receives if the given ID is a known system time zone ID.
status	Receives the status. When the given time zone ID is neither a known system time zone ID nor a valid custom time zone ID, U_ILLEGAL_ARGUMENT_ERROR is set.

Returns

A reference to the result.

Stable:

ICU 4.0

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

Parameters

id	The input time zone ID to be canonicalized.
canonicalID	Receives the canonical system time zone ID or the custom time zone ID in normalized format.
status	Receives the status. When the given time zone ID is neither a known system time zone ID nor a valid custom time zone ID, U_ILLEGAL_ARGUMENT_ERROR is set.

Returns

A reference to the result.

Stable:

ICU 4.0

Returns a name of this time zone suitable for presentation to the user in the specified locale.

This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such asGMT[+-]HH:mm.

Parameters

locale	the locale in which to supply the display name.
result	the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized.

Returns

A reference to 'result'.

Stable:

ICU 2.0

Returns a name of this time zone suitable for presentation to the user in the specified locale.

If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such asGMT[+-]HH:mm.

Parameters

inDaylight	if true, return the daylight savings name.
style
locale	the locale in which to supply the display name.
result	the human-readable name of this time zone in the given locale or in the default locale if the given locale is not recognized.

Returns

A reference to 'result'.

Stable:

ICU 2.0

Returns a name of this time zone suitable for presentation to the user in the default locale.

If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such asGMT[+-]HH:mm.

Parameters

inDaylight	if true, return the daylight savings name.
style
result	the human-readable name of this time zone in the default locale.

Returns

A reference to 'result'.

Stable:

ICU 2.0

Returns a name of this time zone suitable for presentation to the user in the default locale.

This method returns the long name, not including daylight savings. If the display name is not available for the locale, then this method returns a string in the localized GMT offset format such asGMT[+-]HH:mm.

Parameters

result

the human-readable name of this time zone in the default locale.

Returns

A reference to 'result'.

Stable:

ICU 2.0

Returns the amount of time to be added to local standard time to get local wall clock time.

The default implementation always returns 3600000 milliseconds (i.e., one hour) if this time zone observes Daylight Saving Time. Otherwise, 0 (zero) is returned.

If an underlyingTimeZone implementation subclass supports historical Daylight Saving Time changes, this method returns the known latest daylight saving value.

Returns

the amount of saving time in milliseconds

Stable:

ICU 3.6

Reimplemented inicu::SimpleTimeZone.

Returns a unique class ID POLYMORPHICALLY.

This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphicoperator==() andclone() methods call this method.

Concrete subclasses ofTimeZone must use the UOBJECT_DEFINE_RTTI_IMPLEMENTATION macro fromuobject.h in their implementation to provide correct RTTI information.

Returns

The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable:

ICU 2.0

Reimplemented fromicu::UObject.

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Returns an ID in the equivalency group that includes the given ID.

An equivalency group contains zones that have the same GMT offset and rules.

The given index must be in the range 0..n-1, where n is the value returned bycountEquivalentIDs(id). For some value of 'index', the returned value will be equal to the given id. If the given id is not a valid system time zone, or if 'index' is out of range, then returns an empty string.

Parameters

id	a system time zone ID
index	a value from 0 to n-1, where n is the value returned bycountEquivalentIDs(id)

Returns

the ID of the index-th zone in the equivalency group containing 'id', or an empty string if 'id' is not a valid system ID or 'index' is out of range

See also

countEquivalentIDs

Stable:

ICU 2.0

The GMT (=UTC) time zone has a raw offset of zero and does not use daylight savings time.

This is a commonly used time zone.

Note: For backward compatibility reason, the ID used by the time zone returned by this method is "GMT", although the ICU's canonical ID for the GMT time zone is "Etc/GMT".

Returns

the GMT/UTC time zone.

See also

getUnknown

Stable:

ICU 2.0

Returns the preferred time zone ID in the IANA time zone database for the given time zone ID.

There are two types of preferred IDs. The first type is the one defined in zone.tab file, such as "America/Los_Angeles". The second types is the one defined for zones not associated with a specific region, but not defined with "Link" syntax such as "Etc/GMT+10".

Note: For most of valid time zone IDs, this method returns an ID same asgetCanonicalID().getCanonicalID() is based on canonical time zone IDs defined in Unicode CLDR. These canonical time zone IDs in CLDR were based on very old version of the time zone database. In the IANA time zone database, some IDs were updated since then. This API returns a newer time zone ID. For example, CLDR defines "Asia/Calcutta" as the canonical time zone ID. This method returns "Asia/Kolkata" instead.

"Etc/Unknown" is a special time zone ID defined by CLDR. There are no corresponding zones in the IANA time zone database. Therefore, this API returns U_ILLEGAL_ARGUMENT_ERROR when the input ID is "Etc/Unknown".

Parameters

id	The input time zone ID.
ianaID	Receives the preferred time zone ID in the IANA time zone database. When the given time zone ID is not a known time zone ID, this method sets an invalid (bogus) string.
status	Receives the status. When the given time zone ID is not a known time zone ID, U_ILLEGAL_ARGUMENT_ERROR is set.

Returns

A reference to the result.

Stable:

ICU 74

Fills in "ID" with theTimeZone's ID.

Parameters

ID	Receives thisTimeZone's ID.

Returns

A reference to 'ID'

Stable:

ICU 2.0

Definition at line1047 of filetimezone.h.

Converts a Windows time zone ID to an equivalent system time zone ID for a region.

For example, system time zone ID "America/Los_Angeles" is returned for input Windows ID "Pacific Standard Time" and region "US" (ornull), "America/Vancouver" is returned for the same Windows ID "Pacific Standard Time" and region "CA".

Not all Windows time zones can be mapped to system time zones. When the input Windows time zone ID is unknown or unmappable to a system time zone, then the result will be empty, but the operation itself remains successful (no error status set on return).

This implementation utilizesZone-Tzid mapping data. The mapping data is updated time to time. To get the latest changes, please read the ICU user guide sectionUpdating the Time Zone Data.

Parameters

winid	A Windows time zone ID.
region	A NUL-terminated region code, ornullptr if no regional preference.
id	Receives a system time zone ID. When the input Windows time zone ID is unknown or unmappable to a system time zone ID, then an empty string is set on return.
status	Receives the status.

Returns

A reference to the result (id).

See also

getWindowsID

Stable:

ICU 52

Returns the time zone raw and GMT offset for the given moment in time.

Upon return, local-millis = GMT-millis + rawOffset + dstOffset. All computations are performed in the proleptic Gregorian calendar. The default implementation in theTimeZone class delegates to the 8-argumentgetOffset().

Parameters

date	moment in time for which to return offsets, in units of milliseconds from January 1, 1970 0:00 GMT, either GMT time or local wall time, depending on ‘local’.
local	if true, ‘date’ is local wall time; otherwise it is in GMT time.
rawOffset	output parameter to receive the raw offset, that is, the offset not including DST adjustments
dstOffset	output parameter to receive the DST offset, that is, the offset to be added to ‘rawOffset’ to obtain the total offset between local and GMT time. If DST is not in effect, this value is zero; otherwise it is a positive value, typically one hour.
ec	input-output error code

Stable:

ICU 2.8

Reimplemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Returns theTimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get local time in this time zone, taking daylight savings time into account) as of a particular reference date.

The reference date is used to determine whether daylight savings time is in effect and needs to be figured into the offset that is returned (in other words, what is the adjusted GMT offset in this time zone at this particular date and time?). For the time zones produced bycreateTimeZone(), the reference data is specified according to the Gregorian calendar, and the date and time fields are local standard time.

Note: Don't call this method. Instead, call the getOffset(UDate...) overload, which returns both the raw and the DST offset for a given time. This method is retained only for backward compatibility.

Parameters

era	The reference date's era
year	The reference date's year
month	The reference date's month (0-based; 0 is January)
day	The reference date's day-in-month (1-based)
dayOfWeek	The reference date's day-of-week (1-based; 1 is Sunday)
millis	The reference date's milliseconds in day, local standard time
status	Output param to filled in with a success or an error.

Returns

The offset in milliseconds to add to GMT to get local time.

Stable:

ICU 2.0

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Gets the time zone offset, for current date, modified in case of daylight savings.

This is the offset to addto UTC to get local time.

Note: Don't call this method. Instead, call the getOffset(UDate...) overload, which returns both the raw and the DST offset for a given time. This method is retained only for backward compatibility.

Parameters

era	the era of the given date.
year	the year in the given date.
month	the month in the given date. Month is 0-based. e.g., 0 for January.
day	the day-in-month of the given date.
dayOfWeek	the day-of-week of the given date.
milliseconds	the millis in day instandard local time.
monthLength	the length of the given month in days.
status	Output param to filled in with a success or an error.

Returns

the offset to addto GMT to get local time.

Stable:

ICU 2.0

Implemented inicu::SimpleTimeZone,icu::VTimeZone, andicu::RuleBasedTimeZone.

Returns theTimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account).

Returns

TheTimeZone's raw GMT offset.

Stable:

ICU 2.0

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Gets the region code associated with the given system time zone ID.

The region code is either ISO 3166 2-letter country code or UN M.49 3-digit area code. When the time zone is not associated with a specific location, for example - "Etc/UTC", "EST5EDT", then this method returns "001" (UN M.49 area code for World).

Parameters

id	The system time zone ID.
region	Output buffer for receiving the region code.
capacity	The size of the output buffer.
status	Receives the status. When the given time zone ID is not a known system time zone ID, U_ILLEGAL_ARGUMENT_ERROR is set.

Returns

The length of the output region code.

Stable:

ICU 4.8

Returns the region code associated with the given zone, or nullptr if the zone is not known.

Parameters

id	zone id string
status	Status parameter

Returns

the region associated with the given zone

Internal:

Do not use. This API is for internal use only.

Return the class ID for this class.

This is useful only for comparing to a return value fromgetDynamicClassID().

Returns

The class ID for all objects of this class.

Stable:

ICU 2.0

Returns the timezone data version currently used by ICU.

Parameters

status

Output param to filled in with a success or an error.

Returns

the version string, such as "2007f"

Stable:

ICU 3.8

Returns the "unknown" time zone.

It behaves like the GMT/UTC time zone but has theUCAL_UNKNOWN_ZONE_ID = "Etc/Unknown".createTimeZone() returns a mutable clone of this time zone if the input ID is not recognized.

Returns

the "unknown" time zone.

See also

UCAL_UNKNOWN_ZONE_ID

createTimeZone

getGMT

Stable:

ICU 49

Converts a system time zone ID to an equivalent Windows time zone ID.

For example, Windows time zone ID "Pacific Standard Time" is returned for input "America/Los_Angeles".

There are system time zones that cannot be mapped to Windows zones. When the input system time zone ID is unknown or unmappable to a Windows time zone, then the result will be empty, but the operation itself remains successful (no error status set on return).

This implementation utilizesZone-Tzid mapping data. The mapping data is updated time to time. To get the latest changes, please read the ICU user guide sectionUpdating the Time Zone Data.

Parameters

id	A system time zone ID.
winid	Receives a Windows time zone ID. When the input system time zone ID is unknown or unmappable to a Windows time zone ID, then an empty string is set on return.
status	Receives the status.

Returns

A reference to the result (winid).

See also

getIDForWindowsID

Stable:

ICU 52

Returns true if this zone has the same rule and offset as another zone.

That is, if this zone differs only in ID, if at all.

Parameters

other

theTimeZone object to be compared with

Returns

true if the given zone is the same as this one, with the possible exception of the ID

Stable:

ICU 2.0

Reimplemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Queries if the given date is in daylight savings time in this time zone.

This method is wasteful since it creates a newGregorianCalendar and deletes it each time it is called. This is a deprecated method and provided only for Java compatibility.

Parameters

date	the given UDate.
status	Output param filled in with success/error code.

Returns

true if the given date is in daylight savings time, false, otherwise.

Deprecated:

ICU 2.4. UseCalendar::inDaylightTime() instead.

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Utility function.

For internally loading rule data.

Parameters

top	Top resource bundle for tz data
ruleid	ID of rule to load
oldbundle	Old bundle to reuse or nullptr
status	Status parameter

Returns

either a new bundle or *oldbundle

Internal:

Do not use. This API is for internal use only.

Returns true if the two TimeZones are NOT equal; that is, ifoperator==() returns false.

Parameters

that	TheTimeZone object to be compared with.

Returns

true if the givenTimeZone is not equal to thisTimeZone; false otherwise.

Stable:

ICU 2.0

Definition at line550 of filetimezone.h.

Referencesicu::operator==().

Default assignment operator.

Parameters

right

the object to be copied.

Stable:

ICU 2.0

Returns true if the two TimeZones are equal.

(TheTimeZone version only compares IDs, but subclasses are expected to also compare the fields they add.)

Parameters

that	TheTimeZone object to be compared with.

Returns

true if the givenTimeZone is equal to thisTimeZone; false otherwise.

Stable:

ICU 2.0

Reimplemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Same asadoptDefault(), except that theTimeZone object passed in is NOT adopted; the caller remains responsible for deleting it.

Parameters

zone	The given timezone.

System:

Do not use unless you know what you are doing.

Stable:

ICU 2.0

Sets theTimeZone's ID to the specified value.

This doesn't affect any other fields (for example, if you say< blockquote>

.     TimeZone* foo =TimeZone::createTimeZone("America/New_York");.     foo.setID("America/Los_Angeles");

the time zone's GMT offset and daylight-savings rules don't change to those for Los Angeles. They're still those for New York. Only the ID has changed.)

Parameters

ID	The new time zone ID.

Stable:

ICU 2.0

Definition at line1056 of filetimezone.h.

Sets theTimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time, before taking daylight savings time into account).

Parameters

offsetMillis

The new raw GMT offset for this time zone.

Stable:

ICU 2.0

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.

Queries if this time zone uses daylight savings time.

Returns

true if this time zone uses daylight savings time, false, otherwise.

Note:The default implementation of ICUTimeZone uses the tz database, which supports historic rule changes, for system time zones. With the implementation, there are time zones that used daylight savings time in the past, but no longer used currently. For example, Asia/Tokyo has never used daylight savings time since 1951. Most clients would expect that this method to returnfalse for such case. The default implementation of this method returnstrue when the time zone uses daylight savings time in the current (Gregorian) calendar year.

In Java 7,observesDaylightTime() was added in addition touseDaylightTime(). In Java,useDaylightTime() only checks if daylight saving time is observed by the last known rule. This specification might not be what most users would expect if daylight saving time is currently observed, but not scheduled in future. In this case, Java'suserDaylightTime() returnsfalse. To resolve the issue, Java 7 addedobservesDaylightTime(), which takes the current rule into account. The methodobservesDaylightTime() was added in ICU4J for supporting API signature compatibility with JDK. In general, ICU4C also provides JDK compatible methods, but the current implementationuserDaylightTime() serves the purpose (takes the current rule into account),observesDaylightTime() is not added in ICU4C. In addition touseDaylightTime(), ICU4CBasicTimeZone class (Note thatTimeZone::createTimeZone(const UnicodeString &ID) always returns aBasicTimeZone) provides a series of methods allowing historic and future time zone rule iteration, so you can check if daylight saving time is observed or not within a given period.

Stable:

ICU 2.0

Implemented inicu::VTimeZone,icu::SimpleTimeZone, andicu::RuleBasedTimeZone.