ph_deletetimedevent PowerHome formula function
Description
Delete a timed event.
Syntax
ph_deletetimedevent ( )
ph_deletetimedevent ( as_id )
Argument |
Description |
as_id
|
String (Optional). A valid Timed event ID. If this parameter is omitted, then
the system variable TIMEDEVENT will be used for ID
|
Return value
Integer. Returns 0 if successful. Returns 1 if an error occurs
Usage
Use this function to programmatically delete timed events from the
PowerHome system.
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_deletetimedevent("SUNRISE")