The TimeZone plugin retrieves the current time zone and daylight saving time settings for the computer. If the computer is configured for daylight saving time, the plugin returns date and local time when the transition from standard time to daylight saving time, and vice versa, occurs on the operating system.
Syntax:
PLUGIN TimeZone vResult|ACTION GET_INFO
Where:
The following return variables are generated:
Variable |
Description |
vResult |
Returns the current daylight saving time setting:
OK - DST_IN_DAYLIGHT_DATE - daylight saving time auto adjustment is enabled and current time is in daylight date
OK - DST_IN_STANDARD_DATE – daylight saving time auto adjustment is enabled and current time is in standard date
OK - DST_NOT_USED – daylight saving time is not supported, or the automatic daylight saving time adjustment is disabled
-ERROR- TIME_ZONE_ID_INVALID – an error occurred |
vRBTITZBias |
Returns the current bias for local time translation on the computer, in minutes. The bias is the difference, in minutes, between Coordinated Universal Time (UTC) and local time. All translations between UTC and local time are based on the following formula: UTC = local time + bias |
vRBTITZStdName |
Returns the standard time zone name |
vRBTITZStdDate |
Returns the date and local time when the transition from daylight saving time to standard time occurs on the operating system |
vRBTITZStdBias |
Returns the bias value to be used during local time translations that occur during standard time. This value is added to vRBTITZBias to form the bias used during standard time. In most time zones, the value is zero. |
vRBTITZDLName |
Returns the daylight saving time name |
vRBTITZDLDate |
Returns date and local time when the transition from standard time to daylight saving time occurs on the operating system |
vRBTITZDLBias |
Returns the bias value to be used during local time translations that occur during daylight saving time. This value is added to vRBTITZBias to form the bias used during daylight saving time. In most time zones, the value is –60. |
Examples:
Example 01:
The below variables are generated for a computer in the Eastern Standard Time zone, automatically adjusted to ON for daylight saving time:
Variable = Value Type
------------------ ------------------------------ -------
vRBTITZBias = 300 INTEGER
vRBTITZStdName = Eastern Standard Time TEXT
vRBTITZStdDate = 11/01/0000 02:00:00:00 TEXT
vRBTITZStdBias = 0 INTEGER
vRBTITZDLName = Eastern Daylight Time TEXT
vRBTITZDLDate = 03/02/0000 02:00:00:00 TEXT
vRBTITZDLBias = -60 INTEGER
vResult = OK - DST_IN_DAYLIGHT_DATE TEXT
Example 02:
The below variables are generated for a computer in the Pacific Standard Time zone, with the automatic daylight saving time adjustment setting disabled:
Variable = Value Type
------------------ ------------------------------ -------
vRBTITZBias = 480 INTEGER
vRBTITZStdName = Pacific Standard Time TEXT
vRBTITZStdDate = 00/00/0000 00:00:00:00 TEXT
vRBTITZStdBias = 0 INTEGER
vRBTITZDLName = Pacific Standard Time TEXT
vRBTITZDLDate = 00/00/0000 00:00:00:00 TEXT
vRBTITZDLBias = 0 INTEGER
vResult = OK - DST_NOT_USED TEXT
