clrtoeol

, wclrtoeol

- clear to the end of a line

Synopsis

cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
-R /usr/xpg4/lib -lcurses [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]
 
#include <curses.h>

int clrtoeol(void);

int wclrtoeol(WINDOW *win);

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.

Parameters

win

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

Return Values

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

Errors

None.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

bkgdset(3XCURSES), clear(3XCURSES), clearok(3XCURSES), clrtobot(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)