Inverse Modulus Match Enum navigation bar

Table of Contents >Quanser Rapid Control Prototyping Toolkit >VI and Function Reference >VIs - By Category >VI Categories >Utility VIs and Functions >

Match Boolean

Match Boolean

Owning Palette:Utilities

Requirements:Quanser Rapid Control Prototyping Toolkit, LabVIEW 2020 or newer


Description

Returns true if the input string is "true", "yes", "y", "on" or "1". Returns false if the input string is "false", "no", "n", "off" or "0". If the input string is none of these values then it returns an error and the selection output is set to the default input.


Optional Inputs Optional inputs need not to be wired. They are indicated but not labelled in the context help window for the VI.
default

default is the value to output if the input is invalid.


Outputs

selection

selection is true if the input string matched "true", "yes", "y", "on" or "1". It is false if the input string matched "false", "no", "n", "off" or "0". Otherwise it is the default value.

error out error out contains error information. If the error in cluster indicated an error, the error out cluster contains the same information. Otherwise, error out describes the error status of this VI.
status icon status is TRUE if an error occurred. If status is TRUE, the VI does not perform any operations.
code icon code is the error code number identifying an error. A value of 0 means no error, a negative value means a fatal error, and a positive value is a warning. Refer to the Quanser Error Codes for a code description.
source icon source identifies where an error occurred. The source string is usually the name of the VI that produced the error.


Details

This VI returns true if the input string is "true", "yes", "y", "on" or "1". It returns false if the input string is "false", "no", "n", "off" or "0". If the input string is none of these values then it returns an error. The comparison is case-insensitive, so strings such as "True" and "False" also match, as do "ON" and "OFF".


Feedthrough Behaviour

All input/output pairs of this function have direct feedthrough behaviour.


Examples

There are currently no examples


See Also

  • Match Enum Returns the index of the string in the possible values array that matches the input string.

    Targets

    Target

    Supported

    Comments

    RCP Windows (64-bit) Target

    Yes

    Fully supported.

     

    navigation bar