[<<Previous Entry]
[^^Up^^]
[Next Entry>>]
[Menu]
[About The Guide]
CLEARWIN()
Clears a screen area
------------------------------------------------------------------------------
Syntax
CLEARWIN([<nTopLine>], [<nLeftCol>], [<nBottomLine>],
[<nRightCol>], [<cAttr|nAttr>],
[<cCharacter|nCharacter>]) --> cNull
Arguments
<nTopLine> Designates the topmost line where clearing is to begin.
The default value is the cursor line.
<nLeftCol> Designates the leftmost column from which clearing is to
begin. The default value is the cursor column.
<nBottomLine> Designates the bottommost line to clear. The default
is the last screen line or window line.
<nRightCol> Designates the rightmost column to clear. The default
is the right screen border or window border.
<cAttr|nAttr> Designates the attribute to use to clear. The
default is the standard attribute CLEARA.
<cCharacter|nCharacter> Designates the character to use to clear.
The default is the standard character CLEARB.
Returns
CLEARWIN() always returns a null string.
Description
CLEARWIN() clears a specified screen area. This area extends from
< nTopLine> to <nBottomLine> and from <nLeftCol> to <nRightCol>.
Without these parameters, the line and column that correspond to the
current cursor position for <nTopLine> and <nLeftCol>, and the
bottommost line and rightmost column are used for <nBottomLine> and
<nRightCol>.
You can clear with the standard attribute and character (CLEARA and
CLEARB), or with the <cAttr|nAttr> attribute and the
<cCharacter|nCharacter> character.
Notes
. The <cAttr|nAttr> attribute and <cCharacter|nCharacter>
character are specified in different ways. Please refer to the
Introduction of this chapter for more details
. The standard attribute and character are set with SETCLEARA()
and SETCLEARB().
. If no parameters are specified for the line or column, the
function 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:
CLEARWIN()
. Do the same for line 23 from the current cursor position:
CLEARWIN(23)
. Clear a window between line 23, column 15 and line 24, column
70:
CLEARWIN(23, 15, 24, 70)
. You can specify the attributes in different ways. In the
following three examples, the CLEARB() clear character is used.
CLEARWIN(23, 15, 24, 70, 4) // red on black<
CLEARWIN(23, 15, 24, 70, "4/7") // red on white
CLEARWIN(23, 15, 24, 70, "B/W") // blue on white
. Clear when specifying attribute and character:
CLEARWIN(23, 15, 24, 70, "B/W", "+") // blue on white
See Also:
CLWIN()
SETCLEARA()
SETCLEARB()
Introduction
This page created by ng2html v1.05, the Norton guide to HTML conversion utility.
Written by Dave Pearson