ph_setsystemvar PowerHome formula function
Description
Sets the value of a system variable.
Syntax
ph_setsystemvar ( varid, value )
| Argument |
Description |
|
varid
|
String identifying the system variable you would like to modify. |
|
value
|
String which you would like assigned to the system variable. |
Return value
Integer. Returns a 0 if successful and a 1 if the system variable is undefined. Not all system variables can be modified by the user. Examples of non-modifiable system variables are the multi-x X10P0 thru X10P19 system variables as well as MBRET, DIALUPIP, etc.
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_setsystemvar("TEMP1","DWN ROOM")
• ph_setsystemvar("TEMP2","19")
• ph_setsystemvar("LOCAL1", ph_readfile("C:\powerhome\findMyPhone.txt"))
NOTE: Because the contents of the file is 'text' no parentheses’ are required. Had they been used, then the value put into LOCAL1 would have been the file path/name itself.