


curs_clear(3X)                                     curs_clear(3X)


NNAAMMEE
       ccuurrss__cclleeaarr:  eerraassee, wweerraassee, cclleeaarr, wwcclleeaarr, ccllrrttoobboott, wwccllrr--
       ttoobboott, ccllrrttooeeooll, wwccllrrttooeeooll - clear all or part of a ccuurrsseess
       window

SSYYNNOOPPSSIISS
       ## iinncclluuddee <<ccuurrsseess..hh>>

       iinntt eerraassee((vvooiidd));;
       iinntt wweerraassee((WWIINNDDOOWW **wwiinn));;
       iinntt cclleeaarr((vvooiidd));;
       iinntt wwcclleeaarr((WWIINNDDOOWW **wwiinn));;
       iinntt ccllrrttoobboott((vvooiidd));;
       iinntt wwccllrrttoobboott((WWIINNDDOOWW **wwiinn));;
       iinntt ccllrrttooeeooll((vvooiidd));;
       iinntt wwccllrrttooeeooll((WWIINNDDOOWW **wwiinn));;

DDEESSCCRRIIPPTTIIOONN
       The  eerraassee  and wweerraassee routines copy blanks to every posi-
       tion in the window, clearing the screen.

       The cclleeaarr and wwcclleeaarr routines are like eerraassee  and  wweerraassee,
       but  they also call cclleeaarrookk, so that the screen is cleared
       completely on the next call to wwrreeffrreesshh  for  that  window
       and repainted from scratch.

       The  ccllrrttoobboott and wwccllrrttoobboott routines erase from the cursor
       to the end of screen.  That is, they erase all lines below
       the  cursor  in the window.  Also, the current line to the
       right of the cursor, inclusive, is erased.

       The ccllrrttooeeooll and wwccllrrttooeeooll routines erase the current line
       to  the  right of the cursor, inclusive, to the end of the
       current line.

       Blanks created by erasure have the current background ren-
       dition (as set by wwbbkkggnnddsseett) merged into them.

RREETTUURRNN VVAALLUUEE
       All  routines  return  the  integer OOKK.  The SVr4.0 manual
       says "or a non-negative integer if iimmmmeeddookk  is  set",  but
       this appears to be an error.

NNOOTTEESS
       Note that eerraassee, wweerraassee, cclleeaarr, wwcclleeaarr, ccllrrttoobboott, and ccllrr--
       ttooeeooll may be macros.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses  standard,
       Issue  4.   The standard specifies that they return EERRRR on
       failure, but specifies no error conditions.

       Some historic curses implementations had,  as  an  undocu-
       mented  feature,  the  ability  to  do  the  equivalent of



                                                                1





curs_clear(3X)                                     curs_clear(3X)


       cclleeaarrookk((......,,   11))   by    saying    ttoouucchhwwiinn((ssttddssccrr))    or
       cclleeaarr((ssttddssccrr)).  This will not work under ncurses.

SSEEEE AALLSSOO
       ccuurrsseess(3X), ccuurrss__oouuttooppttss(3X), ccuurrss__rreeffrreesshh(3X)




















































                                                                2


