clrtoeol(3xcurses)

1clrtoeol(3XCURSES)      X/Open Curses Library Functions     clrtoeol(3XCURSES)
2
3
4

NAME

6       clrtoeol, wclrtoeol - clear to the end of a line
7

SYNOPSIS

9       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
10        -R  /usr/xpg4/lib  -lcurses  [ library... ]
11
12       c89 [ flag... ] file... -lcurses [ library... ]
13
14       #include <curses.h>
15
16       int clrtoeol(void);
17
18
19       int wclrtoeol(WINDOW *win);
20
21

DESCRIPTION

23       The clrtoeol() function clears the current line from the cursor to  the
24       right margin in the stdscr window. The  wclrtoeol()  function  performs
25       the  same action, but in the window specified by win instead of stdscr.
26       The current background character (and rendition) is used to  clear  the
27       screen.
28
29
30       If  the  clearing action results in clearing only a portion of a multi‐
31       column character, background characters are displayed in place  of  the
32       remaining  portion.
33

PARAMETERS

35       win    Is  a  pointer to the window in which to clear to the end of the
36              line.
37
38

RETURN VALUES

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

ERRORS

43       None.
44

ATTRIBUTES

46       See attributes(5) for descriptions of the following attributes:
47
48
49
50
51       ┌─────────────────────────────┬─────────────────────────────┐
52       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
53       ├─────────────────────────────┼─────────────────────────────┤
54       │Interface Stability          │Standard                     │
55       ├─────────────────────────────┼─────────────────────────────┤
56       │MT-Level                     │Unsafe                       │
57       └─────────────────────────────┴─────────────────────────────┘
58