[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 CLEAREOL()
 Clears from the cursor position to the end of line
------------------------------------------------------------------------------
 Syntax

     CLEAREOL([<nRow>], [<nColumn>], [<cAttr|nAttr>],
        [<cCharacter|nCharacter>]) --> cNull

 Arguments

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

     <nColumn >  Designates the column where the erasure is to begin.
     The default is the cursor column.

     <cAttrn|nAttr>  Designates the attribute used to clear.  The
     default is CLEARA.

     <cCharacter|nCharacter>  Designates the character used to clear.
     The default is CLEARB.

 Returns

     CLEAREOL() always returns a null string.

 Description

     Use CLEAREOL() to clear a specific line from a given position to the end
     of that line.  If arguments are not specified, then the current <nRow>
     cursor line and <nColumn> cursor column are used as the starting
     location.  The clear always goes to the end of the line specified with
     the CLEARA attribute and CLEARB character, or with the <Attr|nAttr>
     attribute and <cCharacter|nCharacter> character.

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

     1. It lets you take the returned value of the character string type and
        combine it with string outputs (e.g., LIST...CLEAREOL()).

     2. The cursor position is not affected.

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

 Notes

     .  You can specify the <cAttr|nAttr> attribute and the
        <cCharacter|nCharacter> character in a number of ways.  Please refer
        to the chapter introduction.

     .  Default attribute and character can be set with SETCLEARA()
        and SETCLEARB().

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

 Examples

     .  Clear from the cursor position to the end of the line with the
        CLEARB character and CLEARA attribute:

        CLEAREOL()

     .  Do the same for line 23 from the current cursor position:

        CLEAREOL(23)

     .  Do the same as before, but begin the erasure at column 55:

        CLEAREOL(23, 55)

     .  The attributes can be specified in different ways.  In the
        following three examples, the clear character is set with
        SETCLEARB():

        CLEAREOL(23, 55, 4)         // red on black
        CLEAREOL(23, 55, "4/7")     // red on white
        CLEAREOL(23, 55, "B/W")     // blue on white

     .  Clear with special attribute and character:

        CLEAREOL(23, 55, "3/1", ":")
        CLEAREOL(23, 55, "B/W", "+")


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