curs_clear(S-osr5)

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-osr5) and werase(S-osr5) routines copy blanks to every position in the window.

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

The clrtobot(S-osr5) and wclrtobot(S-osr5) 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-osr5) and wclrtoeol(S-osr5) 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-osr5) 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-osr5), werase(S-osr5), clear(S-osr5), wclear(S-osr5), clrtobot(S-osr5), wclrtobot(S-osr5), clrtoeol(S-osr5), and wclrtoeol(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.