ph_getteactive PowerHome formula function
Description
Returns whether a Timed Event is active or not
Syntax
ph_getteactive ( )
ph_getteactive ( as_id )
| Argument | Description |
| as_id | String (Optional). The Timed Event ID that you would like
to check is active or not. If this parameter is omitted, the system
variable TIMEDEVENT will be used |
Return value
Integer. Returns 1 if the specified Timed
Event is active.
Returns 0 if the Timed Event is not active. Returns -1 if the specified timed event does not exist
Usage
Use this function to determine if a Timed
Event is currently set to active
within PowerHome
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_getteactive("SPRINKLERMON") -
Returns 1 if timed event SPRINKLERMON is flagged as active in the Timed Events
screen