ph_setlocals PowerHome formula function
Description
Allows for the quick initialization of local variables [LOCAL1] thru [LOCAL5]
Syntax
ph_setlocals ( local1, local2, local3, local4, local5 )
| Argument |
Description |
|
local1
|
Any. The value to assign to [LOCAL1]. Data can be of any standard type.
|
|
local2
|
Any. The value to assign to [LOCAL2]. Data can be of any standard type.
|
|
local3
|
Any. The value to assign to [LOCAL3]. Data can be of any standard type.
|
|
local4
|
Any. The value to assign to [LOCAL4]. Data can be of any standard type.
|
|
local5
|
Any. The value to assign to [LOCAL5]. Data can be of any standard type.
|
Return value
Integer. Returns 0.
Usage
Use this function to rapidly set the first
5 LOCAL variables. If you only want to set some of the LOCAL variables, supply a
string containing a single space for the variables you wish to leave unchanged.
Examples
The following examples demonstrate typical
syntax/usage for this function.
ph_setlocals(35,"Test","
",2014-06-19,321.25)
The above example will set LOCAL1,
LOCAL2, LOCAL4, and LOCAL5 to the specified number, string, date, and decimal
respectively. LOCAL3 will not be changed since it is set to a single space.