ph_returnallvars PowerHome formula function
Description
Returns
a string containing the values
of the requested LOCAL, TEMP, and SYSTEM variables within
the current
execution space
Syntax
ph_returnallvars ( )
ph_returnallvars ( ai_flags )
| Argument | Description |
|
ai_flags
|
Integer (Optional). A flags parameter
representing which group of variables you would like to return. Add the
values together to get the desired result. A value of 2 will return
the LOCAL variables. A value of 4 will return the
TEMP variables. A value of 8 will return the SYSTEM variables. Add a value
of 1 to the total to have each of the LOCAL and TEMP variables
trimmed to a max of 40 characters. If this parameter is omitted, a value of 15
will be used to return all 3 sets of variables with the LOCAL and TEMP variables each trimmed to a max of 40 characters |
Return value
String. Returns
a string containing all of
the values of the requested LOCAL, TEMP,
and SYSTEM variables
Usage
Use this function to quickly snapshot the
internal variables within the
current execution space. Very useful for debugging
and for verifying output for macros
and triggers.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_returnallvars() - A sample return
from this
function could look like
this:
| LOCAL1 = 0
| LOCAL2 = 0
| LOCAL3 = 0
| LOCAL4 =
| LOCAL5 =
| LOCAL6 =
| LOCAL7 =
| LOCAL8 =
| LOCAL9 =
| LOCAL10 =
| TEMP1 =
| TEMP2 =
| TEMP3 =
| TEMP4 =
| TEMP5 =
| TEMP6 =
| TEMP7 =
| TEMP8 =
| TEMP9 =
| TEMP10 =
| MACROID =
| MACROROW = 0
| MACRORET =
| MACROJUMPS = 0
| SUBMACROPATH =
| SUBMACROCNT =
0
| TRIGGERID =
| FORMULAID =
| TIMEDEVENTID =
| CCTABID =
| CCOBJID =
| ANALOGID =
| ZWAVEID =
| ANALOGRAW = 0
| OANALOGRAW = 0
| ANALOGCALC =
| FORECOLOR = 0
| BACKCOLOR = 0
| MBTYPE = 0
| MBRET = 0
| MBMSG =
| INPUTRET =
| INPUTMSG =
| CCOBJX = 0
| CCOBJY = 0
| MTRET = 0
| ERRNUM = 0
| ERRTEXT =