False

(Engine-Level Function)

Description:	For use in expressions that perform Boolean logic. Using "FALSE" will make your code easier to read than using "0".
Returns:	With no parameters, returns the value, 0. If given a parameter, this function will return a 1 or 0 depending on whether the parameter evaluates to FALSE or TRUE. Always returns 0 if the parameter is Invalid.
Usage:	Script or steady state.
Function Groups:	Logic Control
Related to:	True
Format:	False[(TestExpr)]
Parameters:

TestExpr

Optional. Any expression that evaluates to a 1 or 0 value. If no parameter is provided, then there is no need to include the parentheses.

Comments:

This function exists to make your code more readable. It is equivalent to PickValid(Cast(Parameter, 0) == 0, 0); For compatibility with the VTScada style guide, use all caps (TRUE and FALSE) when used as a constant. Capitalize only the first letter when used as a function call: True(test expression) and False(test expression).

Examples:

Used as a function:

  If False(TestVariable); ...

Used as a constant:

   { Initialize error variable to FALSE }
  Error = FALSE;

Used as a function parameter:

   { Get list of immediate tag children }
  \GetTagList("MyParentTag", FALSE);