curs_clear(S)

curs_clear: erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol -- clear all or part of a curses window

Syntax

cc ... -lcurses

# include <curses.h>

int erase(void);
int werase(WINDOW *win);
int clear(void);
int wclear(WINDOW *win);
int clrtobot(void);
int wclrtobot(WINDOW *win);
int clrtoeol(void);
int wclrtoeol(WINDOW *win);

Description

The erase(S) and werase(S) routines copy blanks to every position in the window.

The clear(S) and wclear(S) routines are like erase( ) and werase( ), but they also call clearok(S), so that the screen is cleared completely on the next call to wrefresh(S) for that window and repainted from scratch.

The clrtobot(S) and wclrtobot(S) routines erase all lines below the cursor in the window. Also, the current line to the right of the cursor, inclusive, is erased.

The clrtoeol(S) and wclrtoeol(S) routines erase the current line to the right of the cursor, inclusive.

Return values

All routines return the integer OK, or a non-negative integer if immedok(S) is set.

Warning

The header file curses.h automatically includes the header files stdio.h and unctrl.h.

The following can be macros: erase( ), werase( ), clear( ), wclear( ), clrtobot( ), and clrtoeol( ).

Files

/usr/lib/libcurses.a: the library

Standards conformance

erase(S), werase(S), clear(S), wclear(S), clrtobot(S), wclrtobot(S), clrtoeol(S), and wclrtoeol(S) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.