Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wclrtobot(3cur) [ultrix man page]

clrtobot(3cur)															    clrtobot(3cur)

       clrtobot, wclrtobot - clear to end of screen

       #include <cursesX.h>

       int clrtobot()

       int wclrtobot(win)
       WINDOW *win;

       The routine begins at the current cursor position in the default window and changes the remainder of the screen to blanks. The current cur-
       sor position is also changed to a blank.

       The routine begins at the current cursor position in the specified window and changes the rest of the screen to blanks, including the  cur-
       rent cursor position.

       The routine is a macro.

Return Values
       The and functions return OK on success and ERR on error.


Check Out this Related Man Page

curs_clear(3X)															    curs_clear(3X)

erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol - clear all or part of a curses window SYNOPSIS
# 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 and werase routines copy blanks to every position in the window, clearing the screen. The clear and wclear routines are like erase and werase, but they also call clearok, so that the screen is cleared completely on the next call to wrefresh for that window and repainted from scratch. The clrtobot and wclrtobot routines erase from the cursor to the end of screen. That is, they erase all lines below the cursor in the win- dow. Also, the current line to the right of the cursor, inclusive, is erased. The clrtoeol and wclrtoeol 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 wbkgdset) merged into them. RETURN VALUE
All routines return the integer OK. The SVr4.0 manual says "or a non-negative integer if immedok is set", but this appears to be an error. NOTES
Note that erase, werase, clear, wclear, clrtobot, and clrtoeol may be macros. PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. The standard specifies that they return ERR on failure, but specifies no error conditions. Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of clearok(..., 1) by saying touch- win(stdscr) or clear(stdscr). This will not work under ncurses. SEE ALSO
curses(3X), curs_outopts(3X), curs_refresh(3X) curs_clear(3X)
Man Page