[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 CLEOL()
 Clears characters and attributes to the end of a line
------------------------------------------------------------------------------
 Syntax

     CLEOL([<nRow>], [<nColumn>]) --> cNull

 Arguments

     <nRow>  Designates the line to clear.  The default is the cursor
     line.

     <nColumn>  Designates the column from which to clear.  The default
     is the cursor column.

 Returns

     CLEOL() always returns a null string.

 Description

     Implement the CLEOL() function when you need to clear to black and
     cannot use the standard attribute and character.  This function is
     especially useful with a monochrome video card.  A significant advantage
     of CLEOL() over CLEAREOL(), is the omission of the
     <cAttr|nAttr> and <cCharacter|nCharacter> parameters, which increase the
     speed of CLEOL().  The function is faster because it does not note the
     CLEARA and CLEARB settings.

     CLEOL() has some advantages over the CA-Clipper @ Row, Column commands:

     1. The function allows you to take the returned value of the character
        string type and combine it with string outputs (e.g.,
        LIST...CLEOL()).

     2. The cursor position is not affected.

     3. The parameters are optional.  If they are not specified, the function
        clears from the current cursor position with the CLEARA attribute and
        the CLEARB character.

 Note

     .  If no parameters are specified for line or column, the
        function automatically orients itself to the current cursor position.

 Examples

     .  Clear from the current cursor position to the end of the line:

        CLEOL()

     .  Clear line 23, starting from the cursor column position to the
        end of the line:

        CLEOL(23)

     .  Clear line 23 from column 15 to the end of the line.

        CLEOL(23, 15)


See Also: CLEAREOL() CLEARWIN() CLWIN() Introduction
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson