Page tree
Skip to end of metadata
Go to start of metadata

%NextTime function


Old name
%NextTimeT


Function

The function returns the value of the following time stamp which is newer than current time. Time stamp value is given by the period Period and by the time offset Offset, that are given in seconds. Result is an absolute time.

Declaration

TIME %NextTime(
   INT in Period, 
   INT in Offset, 
   UNIVAL in CalcTrigger,
   TEXT in timeZone := %GetCurrentTimeZone()
 )
Parameters
periodPeriod [s] - must be a positive value.
offsetOffset [s] - may be a negative value, too.
CalcTriggerAn object, which change recalculates the function. Its type is arbitrary. Trigger is used only when in eval tags and ignored in ESL scripts.
Note: This parameter was implemented when there were no eval tags with triggers. If a tag is to be evaluated when a particular object changes, use an eval tag with trigger.
timeZoneName of the time zone used for conversion to local time (e.g. "Europe/London") or definition of fixed offset from UTC using format "(+|-)hh[:mi[:ss]]", where hh defines number of hours, mi defines number of minutes, and ss defines number of seconds. Sign as well as number of hours are mandatory parts of offset definition, number of minutes and seconds are optional and default to 0 (e.g. "+02:30" defines offset of 2 hours and 30 minutes from UTC). Empty text has the same meaning as function %GetCurrentTimeZone.
Note: For historical reasons, integer parameter is also accepted. Its interpretation is as follows: 0 - zone "Europe/London", 3600 - zone "Europe/Bratislava", 7200 - zone "Europe/Kiev", 21600 - zone "Asia/Almaty". Usage of integer parameter is deprecated and generates warning into log file!
Write a comment…