xHarbour Reference Documentation > Function Reference

ClearEol()

Clears a row on the screen beginning at a specified position.

Syntax

ClearEol( [<nRow>]  , ;
          [<nCol>]  , ;
          [<xColor>], ;
          [<xChar>]   ) --> cNull

Arguments

<nRow>

A numeric value indicating the screen row to clear. It defaults to Row().

<nCol>

A numeric value indicating the screen column to begin to clear. It defaults to Col().

<xColor>

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

<xChar>

This is a single character or its numeric ASCII code. It is displayed in the screen row beginning at the specified column to the rightmost column. The default value is determined by GetClearB().

Return

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

Note:  the function does not change the current screen cursor position.

Info

See also:	ClEol(), SetClearA(), SetClearB()
Category:	CT:Video , Screen functions
Source:	ct\screen3.prg
LIB:	xhb.lib
DLL:	xhbdll.dll

Example

// The example displays a dashed yellow line across the screen in
// every fifth row.

   PROCEDURE Main
      LOCAL i
      CLS

      FOR i:=0 TO MaxRow()
         ? Str(i,2),": "

         IF i % 5 == 0
            ?? ClearEol( , , "GR+/N", "-" )
         ENDIF
      NEXT
   RETURN