Qore Programming Language Reference Manual
0.8.9
|
The TimeZone class provides access to time zone functionality. More...
Public Member Functions | |
int | UTCOffset () |
Returns the number of seconds east of UTC for the zone; negative numbers indicate a zone west of UTC. More... | |
constructor (string region) | |
Creates the TimeZone object based on the region name (ex: "America/Chicago" ) More... | |
constructor (softint seconds_east) | |
Creates the TimeZone object based on the number of seconds east of UTC (3600 = UTC +01) More... | |
copy () | |
Creates a copy of the TimeZone object. More... | |
date | date (softint secs, softint us=0) |
Returns the equivalent date in the time zone of the current object. More... | |
date | date (date d) |
Returns the equivalent date in the time zone of the current object. More... | |
date | date (string dtstr) |
Returns the equivalent date in the time zone of the current object. More... | |
date | date (string dtstr, string mask) |
Returns a date/time value in the current TimeZone corresponding to parsing a string argument according to a format mask. More... | |
date | dateMs (softint ms) |
Returns a date in the object's zone based on an offsets in milliseconds from 1970-01-01Z . More... | |
date | dateUs (softint us) |
Returns a date in the object's zone based on an offsets in microseconds from 1970-01-01Z . More... | |
bool | hasDST () |
Returns True if the zone has daylight saving's time rules, False if not. More... | |
string | region () |
Returns the region name as a string; if the current zone is based on a UTC offset, then the UTC offset is returned as a string like "+01:00" . More... | |
Static Public Member Functions | |
static TimeZone | get () |
Returns a TimeZone object for the current time zone. More... | |
static nothing | set (TimeZone zone) |
Sets the time zone for the current Program object from a TimeZone object. More... | |
static nothing | setRegion (string region) |
Sets the time zone for the current Program object from a time zone region name. More... | |
static nothing | setUTCOffset (softint seconds_east) |
Sets the time zone for the current Program object from an integer offset in seconds east of UTC. More... | |
The TimeZone class provides access to time zone functionality.
TimeZone objects based on zoneinfo region files (on UNIX) or registry information (on Windows) can have daylight savings time information; those based on UTC offsets have none.
Qore::TimeZone::constructor | ( | string | region | ) |
Creates the TimeZone object based on the region name (ex: "America/Chicago"
)
region | The region name for the time zone (ex: "America/Chicago" ); if the zoneinfo file for the region cannot be found or parsed (on UNIX) or if the registry entry cannot be found (on Windows), then an exception is thrown |
HKEY_LOCAL_MACHINE SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
(ex: "Central Europe Standard Time"
)TZINFO-ERROR | Unable to read zoneinfo file; invalid file magic; error parsing zoneinfo file, etc |
Qore::TimeZone::constructor | ( | softint | seconds_east | ) |
Creates the TimeZone object based on the number of seconds east of UTC (3600 = UTC +01)
seconds_east | The number of seconds east of UTC for the time zone; for zones west of UTC, use negative numbers |
Qore::TimeZone::copy | ( | ) |
Creates a copy of the TimeZone object.
date Qore::TimeZone::date | ( | softint | secs, |
softint | us = 0 |
||
) |
date Qore::TimeZone::date | ( | date | d | ) |
Returns the equivalent date in the time zone of the current object.
d | A date that will be used to create the date in the time zone of the objects; the same point in time will be returned but in the time zone of the object |
date Qore::TimeZone::date | ( | string | dtstr | ) |
Returns a date/time value in the current TimeZone corresponding to parsing a string argument according to a format mask.
dtstr | a string giving a date |
mask | the mask for the date value; see Date Mask Format for information on the format of the format mask |
DATE-CONVERT-ERROR | invalid mask specification |
date Qore::TimeZone::dateMs | ( | softint | ms | ) |
Returns a date in the object's zone based on an offsets in milliseconds from 1970-01-01Z
.
ms | an offsets in milliseconds from 1970-01-01Z |
1970-01-01Z
date Qore::TimeZone::dateUs | ( | softint | us | ) |
Returns a date in the object's zone based on an offsets in microseconds from 1970-01-01Z
.
us | an offsets in microseconds from 1970-01-01Z |
1970-01-01Z
|
static |
Returns a TimeZone object for the current time zone.
bool Qore::TimeZone::hasDST | ( | ) |
Returns True if the zone has daylight saving's time rules, False if not.
TimeZone objects based on zoneinfo region files (on UNIX) or registry information (on Windows) can have (but do not necessarily have) daylight savings time information; those based on UTC offsets have none
string Qore::TimeZone::region | ( | ) |
Returns the region name as a string; if the current zone is based on a UTC offset, then the UTC offset is returned as a string like "+01:00"
.
"+01:00"
|
static |
Sets the time zone for the current Program object from a TimeZone object.
zone | the time zone to set |
|
static |
Sets the time zone for the current Program object from a time zone region name.
region | the region name to set |
HKEY_LOCAL_MACHINE SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
(ex: "Central
Europe Standard Time)
|
static |
Sets the time zone for the current Program object from an integer offset in seconds east of UTC.
seconds_east | the number of seconds east of UTC for the new time zone (negative numbers give seconds west of UTC) |