MAINSAIL Language Manual, Section 46.15

previous   next   top   contents   index   framed top   this page unframed


46.15. $removeBoolean

Figure 46–19. $removeBoolean
STRING
PROCEDURE   $removeBoolean
                        (
MODIFIES STRING s;
                         
OPTIONAL BITS ctrlBits);

$removeBoolean reads a BOOLEAN STRING representation from the beginning of s. $removeBoolean returns the null STRING if s does not begin with either "TRUE" or "FALSE" (case is ignored). Otherwise, it removes the BOOLEAN STRING representation from s. The BOOLEAN STRING representation in s need not be followed by a blank, tab, end-of-line, or end-of-page; i.e., $removeBoolean looks for and removes from s only the characters TRUE or FALSE.

The only valid ctrlBits bit is discard. If set, initial blank, tab, end-of-page, carriage return, and linefeed characters are removed from s before looking for the BOOLEAN STRING representation.

If s does not begin with a valid BOOLEAN STRING representation (following whitespace characters if discard is set), s is not altered.


previous   next   top   contents   index   framed top   this page unframed

MAINSAIL Language Manual, Section 46.15