« Back to Product

Documentation

IPS_GetScriptTimer

 int IPS_GetScriptTimer (int $ScriptID) 

Parameters

ScriptID

ID of the script

Returns

Time in seconds that the script is called cyclically (not the remaining duration)

Description

The function returns the start value of the script timer of the script with the ID ScriptID. The value describes the duration in seconds. The function can be used to check if the value is set correctly.

If the start value is 0, the timer is deactivated and the script is not executed by the timer. As IPS_SetScriptTimer only accepts values less than 86400 (one day), the value is between 0 and 86399.

Example

$TimerValue = IPS_GetScriptTimer($ScriptID);  // determines the value of the script timer
Any questions?