CLRTOEOL(3XCURSES) X/Open Curses Library Functions CLRTOEOL(3XCURSES)
NAME
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(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Standard |
+--------------------+-----------------+
|MT-Level | Unsafe |
+--------------------+-----------------+
SEE ALSO
bkgdset(3XCURSES),
clear(3XCURSES),
clearok(3XCURSES),
clrtobot(3XCURSES),
libcurses(3XCURSES),
attributes(7),
standards(7) June 5, 2002 CLRTOEOL(3XCURSES)
