ph_pidclear PowerHome formula function
Description
Allows the user to delete previously saved
PID data (created with the ph_pid( ) function) from the PID database table
Syntax
ph_pidclear ( as_id )
| Argument | Description |
| as_id | String. The ID of the PID data you would like
to delete. Use an empty string "" to clear ALL the saved PID data |
Return value
Integer. Returns 0 if successful. If
an error occurs while deleting the data, a 1 will be returned. Specifying an
invalid PID ID will not return an error and will return 0. An error occurs only
if
the table delete fails
Usage
Use this function to delete no longer
needed PID data from the PID
database table
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_pidclear("TESTPID") - Returns 0
and deletes just the data associated with the PID ID
"TESTPID"
• ph_pidclear("") - Returns 0 and deletes ALL
currently stored PID
data