clrtobot wclrtobot

The clrtobot and wclrtobot routines are used to clear to the end of the window.

Syntax

   #include <curses.h>



   int clrtobot();

   int wclrtobot(WINDOW *win);

Parameters

win: A pointer to the window that is to be cleared.

Return Values

OK: Successful completion.
ERR: An error occurred.

Description

The clrtobot() routine clears all characters in the stdscr window from the cursor to the end of the window. The wclrtobot() routine performs the same action in the window specified by win instead of in stdscr. The current background character (and attributes) is used to clear the screen.




	NOTE: The `clrtobot()` routine is a macro.

Implementation Considerations

Identical to XPG/3

Portability

HP-UX, UNIX System V, XPG/3

clrtobot wclrtobot

Technical documentation

» Table of Contents

» Index