Content-type: text/html Man page of curs_clear

curs_clear

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

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

SYNOPSIS

#include <curses.h>

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

LIBRARY

Curses Library (libcurses)
 

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

clear, wclear, erase, werase, clrtobot, wclrtobot, clrtoeol, wclrtoeol:  XPG4, XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.
 

DESCRIPTION

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

The clear and wclear routines are similar to erase and werase but also call clearok. The result is 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 all lines below the cursor in the window. In addition, these routines erase the current line to the right of the cursor, including the character on which the cursor is positioned.

The clrtoeol and wclrtoeol routines erase the current line to the right of the cursor, including the character on which the cursor is positioned.
 

NOTES

The header file <curses.h> automatically includes the header file <stdio.h>.

Note that erase, werase, clear, wclear, clrtobot, and clrtoeol may be macros.
 

RETURN VALUES

Upon successful completion, these routines return OK; otherwise, they return ERR.
 

SEE ALSO

Functions: curses(3), curs_outopts(3), curs_refresh(3)

Others: standards(5)


 

Index

NAME
SYNOPSIS
LIBRARY
STANDARDS
DESCRIPTION
NOTES
RETURN VALUES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:42:18 GMT, October 02, 2010