ph_getvarsub PowerHome formula function
Description
Returns the value of the variable
substitution
parameter.
Syntax
ph_getvarsub (
)
Return value
Integer. The value of the variable
substitution parameter. If variable substitution is enabled, then 1 is
returned. If variable substitution is disabled then 0
is returned.
Usage
Within the pwrhome.ini file under the
[Script] section is a parameter named VARSUBSTITUTION. If this parameter is
set to NO, then variable substitution is disabled and syntax such as [LOCAL1] or
{TEMP} within formulas will NOT be substituted and will instead be interpreted
as literal text. If the parameter is set to YES, then variable
substitution will
be performed.
Examples
The following examples demonstrate typical syntax/usage for this function.
ph_getvarsub()