GetTimeZoneOffset
Returns the number of minutes to add to or subtract from UTC time to get the local time.
Syntax
GetTimeZoneOffset([<value> [, <time> [, <ignore_daylight_saving>]]])
Parameters
<value>
Type: None
(Optional.) Long or Text value specifying time zone to use.
<time>
Type: Date
(Optional.) Local date and time to use.
<ignore_daylight_saving>
Type: Boolean
(Optional.) Whether to ignore adjustments for daylight-saving time. The default value is False.
(return)
Type: Long
Offset from UTC time in minutes.
Notes
If Val is a Long value, it is the index value of a time zone defined in the registry on the server.
If Val is a Text value, it is the name of a time zone defined in the registry on the server.
If
Val is omitted, NULL or empty, the time zone associated with the program in which the function is called is used. By default, the program's time zone is the local time zone of the server, but this can be changed by calling
SetTimeZone.
If a time zone name is used, it is case-insensitive.
The special values of -1 and “UTC” can be used for the time zone; these do not correspond to anything in the registry, but instead refer to UTC time, with no offset or daylight saving defined.
If Val is any other type, an error occurs. If the time zone specified by Val cannot be found in the registry, an error occurs.
If Time is omitted or 0, then 30 December 1899, 00:00:00 (that is, the date internally represented by the numeric value 0) is used.
The return value is the number of minutes (possibly negative) to add to UTC time to get the local time. This includes an adjustment for daylight saving, if daylight saving is currently in effect in the time zone and <ignore_daylight_saving> is false.
See also