cursclear(3X) cursclear(3X)

NAME
       eerraassee, wweerraassee, cclleeaarr, wwcclleeaarr, ccllrrttoobboott, wwccllrrttoobboott, ccllrrttooeeooll, wwccllrrttooeeooll
       - clear all or part of a ccuurrsseess window

SYNOPSIS
       ## iinncclluuddee <>

       iinntt eerraassee((vvooiidd));;
       iinntt wweerraassee((WWIINNDDOOWW **wwiinn));;
       iinntt cclleeaarr((vvooiidd));;
       iinntt wwcclleeaarr((WWIINNDDOOWW **wwiinn));;
       iinntt ccllrrttoobboott((vvooiidd));;
       iinntt wwccllrrttoobboott((WWIINNDDOOWW **wwiinn));;
       iinntt ccllrrttooeeooll((vvooiidd));;
       iinntt wwccllrrttooeeooll((WWIINNDDOOWW **wwiinn));;

DESCRIPTION
       The eerraassee and wweerraassee routines copy blanks to every position in the win-
       dow, clearing the screen.

       The  cclleeaarr and wwcclleeaarr routines are like eerraassee and wweerraassee, but they also
       call cclleeaarrookk, so that the screen is cleared completely on the next call
       to wwrreeffrreesshh for that window and repainted from scratch.

       The ccllrrttoobboott and wwccllrrttoobboott 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 ccllrrttooeeooll and wwccllrrttooeeooll 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 rendition (as set
       by wwbbkkggddsseett) merged into them.

RREETTUURRNN VVAALLUUEE
       All routines return the integer OOKK on success and EERRRR on failure.   The
       SVr4.0  manual  says "or a non-negative integer if iimmmmeeddookk is set", but
       this appears to be an error.

       X/Open defines no error conditions.  In this implementation,  functions
       using a window pointer parameter return an error if it is null.

NNOOTTEESS
       Note  that  eerraassee, wweerraassee, cclleeaarr, wwcclleeaarr, ccllrrttoobboott, and ccllrrttooeeooll may be
       macros.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses standard, Issue 4.  The
       standard  specifies  that  they return EERRRR on failure, but specifies no
       error conditions.

       Some historic curses implementations had, as an  undocumented  feature,
       the  ability  to  do the equivalent of cclleeaarrookk((......,, 11)) by saying ttoouucchh-
       wwiinn((ssttddssccrr)) or cclleeaarr((ssttddssccrr)).  This will not work under ncurses.

       This implementation, and others such as Solaris, sets the current posi-
       tion  to 0,0 after erasing via wweerraassee(()) and wwcclleeaarr(()).  That fact is not
       documented in other implementations, and may not be true of implementa-
       tions which were not derived from SVr4 source.

SEE ALSO
       ccuurrsseess(3X), ccuurrssoouuttooppttss(3X), ccuurrssrreeffrreesshh(3X)



                                                                cursclear(3X)