IsEqual
Deprecated. Do not use in new code.
(VTScada-Layer function. Must be called with a leading backslash.)
Description: |
Exists only for backward compatibility. Use StrictlyEqual or StrictlyNotEqual for all new code. Will return TRUE if the parameter values are equivalent, or if both are invalid. |
Returns: | Boolean |
Usage: | Script or steady state. |
Function Groups: | Variable |
Related to: | Valid | StrictlyEqual | StrictlyNotEqual |
Format: | \IsEqual(Parm1, Parm2); |
Parameters: |
Parm1 |
Required. Any value, to be compared to parameter 2. |
Parm2 |
Required. Any value, to be compared to parameter 1. |
Comments: |
This function is equivalent to the longer expression: !Valid(Parm1) == !Valid(Parm2) OR Parm1 == Parm2 If the parameters are text or numeric, they will be compared directly. If the parameters are expressions, the strings that they evaluate to will be compared. If object values, the Name variables will be used, thus allowing tag to tag comparisons. Other value types will be turned into strings before the comparison. |
Examples:
If !\IsEqual(Color, ChosenColor); [ Color = ChosenColor; EnableColorSelect = 0; ]