NAME

clrtoeol, wclrtoeol − clear to the end of a line

SYNOPSIS

#include <curses.h>

int clrtoeol(void);

int wclrtoeol(WINDOW ∗win);

ARGUMENTS

winIs a pointer to the window in which to clear to the end of the line. 

DESCRIPTION

The clrtoeol() function clears the current line from the cursor to the right margin in the stdscr window.  The wclrtoeol() function performs the same action, but in the window specified by win instead of stdscr.  The current background character (and rendition) is used to clear the screen. 

If the clearing action results in clearing only a portion of a multicolumn character, background characters are displayed in place of the remaining portion. 

RETURN VALUES

On success, these functions return OK.  Otherwise, they return FALSE. 

ERRORS

None. 

SEE ALSO

bkgdset(3XC), clear(3XC), clearok(3XC), clrtobot(3XC)

SunOS 5.6  —  Last change: 1 Jun 1996