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

NAME

6       clrtobot, wclrtobot - clear to the end of a window
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 clrtobot(void);
17
18
19       int wclrtobot(WINDOW *win);
20
21

DESCRIPTION

23       The  clrtobot()  function  clears  all characters in the stdscr  window
24       from the cursor to the end of the window. The wclrtobot() function per‐
25       forms  the  same  action  in the window  specified by win instead of in
26       stdscr. The current background character (and  rendition)  is  used  to
27       clear the 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 that is to be cleared.
36
37

RETURN VALUES

39       On success, these functions return OK. Otherwise, they return ERR.
40

ERRORS

42       None.
43

ATTRIBUTES

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

SEE ALSO

59       bkgdset(3XCURSES),     clear(3XCURSES),     clearok(3XCURSES),     clr‐
60       toeol(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)
61
62
63
64SunOS 5.11                        5 Jun 2002                clrtobot(3XCURSES)
Impressum