xHarbour Reference Documentation > Function Reference

ClearWin()

Clears all or parts of the screen.

Syntax

ClearWin( [<nTop>]   , ;
          [<nLeft>]  , ;
          [<nBottom>], ;
          [<nRight>] , ;
          [<xColor>] , ;
          [<xChar>]    ) --> cNull

Arguments

<nTop> and <nLeft>

Numeric values indicating the screen coordinates for the upper left corner of the screen area to clear. The default value for both parameters is determined by Row() and Col().

<nBottom>

Numeric value indicating the bottom row screen coordinate. It defaults to MaxRow().

<nRight>

Numeric value indicating the right column screen coordinate. It defaults to MaxCol().

<xColor>

This is either a single color value (see SetColor()), or its numeric color attribute (see ColorToN()). It defines the color for clearing the screen and defaults to the return value of GetClearA().

<xChar>

This is a single character or its numeric ASCII code. It is used for clearing the screen and defaults to the return value of GetClearB().

Return

The return value is always a null string ("").

Note:  ClearWin() leaves the cursor position unchanged.

Info

See also:	@...CLEAR, ClearSlow(), ClWin(), SetClearA(), SetClearB()
Category:	CT:Video , Screen functions
Source:	ct\setclear.c
LIB:	xhb.lib
DLL:	xhbdll.dll

Example

   PROCEDURE Main
      SET COLOR TO N/B
      CLS

      SetPos( 2, 20 )
      ClWin()
   RETURN