Boolean
(System Library)
Description: | Takes a valid Boolean test and returns the numeric equivalent. |
Returns: | Numeric |
Usage: | Script or steady state. |
Function Groups: | Logic Control |
Related to: | Boolean Logic Operators | Case | Cond | If | IfElse| IfOne | IfThen | PickValid |
Format: | System.Boolean(Variable) |
Parameters: |
Variable |
Required. The variable whose value is to be converted. |
Comments:
This module is a member of the System Library, and must therefore be prefaced by \System. as shown in the "Format" section.
If your application predates version 11.2, use the backslash notation rather than dot: \System\
The return value from this module is 1 if Variable contains a valid Boolean true of any case ("true", "t", "yes", "y", "on") and 0 otherwise.
Example:
Var = PickValid(System.Boolean(Var), 0);