Click above to get retro games delivered to your door ever month!

CLEAREOL()

Syntax:     CLEAREOL([<expN1>][,<expN2>][,<attr>][,<char>])

Arguments:  <expN1> determines the line in which the erasure takes
            place (default: cursor line).
            <expN2> denotes the first column that will be erased
            (default: cursor column).
            <attr> is the attribute used for the erasure (default: CLEARA).
            <char> is the character to be used for erasure (default:
            CLEARB).

Returns:    A character string.
            A null string is returned.

Usage:      CLEAREOL() can be used to erase a specific line to the
            end.  If <expN1> and <expN2> are not passed, then the
            actual cursor line is used for <expN1> and the actual cursor
            column is used for <expN2>.  The erasure will always be to
            the end of the line with the attribute CLEARA and the
            character CLEARB or, if passed, the line with the attribute
            <attr> and the character <char>.  The function CLEAREOL()
            has certain advantages compared to the Clipper @ command:

            1.  It is a function returning a null string so can be combined
                with string outputs.  (LIST...CLEAREOL()).
            2.  The cursor position will not be changed.
            3.  The arguments are optional.  If they are not specified, the
                function will erase from the current cursor position
                with the attribute CLEARA and the character CLEARB.

Notes:      The attribute <attr> and the character <char> can be specified in
            different ways.  As noted in the introduction to this section,
            the standard attribute and character may be set with
            SETCLEARA() or SETCLEARB().

            The function will automatically default to the actual cursor
            position if no arguments are specified for lines or columns.

Library:    CT1.LIB


--------------------------------- Example ------------------------------

Examples:   * Erase from the cursor position to the end
            * of the line with the character CLEARB and
            * the attribute CLEARA.
            CLEAREOL()

            * The same for line 23 from the actual
            * column position.
            CLEAREOL(23)

            * Here the erasure will be as before,
            * however, from column 55.
            CLEAREOL(23,55)

            * The attribute can be indicated in different
            * forms.  The erasure character present using
            * SETCLERAB() will be used in the following
            * three examples.
            CLEAREOL(23,55,4)                   && Red on black
            CLEAREOL(23,55,"4/1")               && Red on white
            CLEAREOL(23,55,"B/W")               && Blue on white

            * Erase with special attribute * and with
            * characters.
            CLEAREOL(23,55,"4/1",":")
            CLEAREOL(23,55,"B/W","+")