doupdate(3xcurses)

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

NAME

6       doupdate, refresh, wnoutrefresh, wrefresh - refresh windows and lines
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 doupdate(void);
17
18
19       int refresh(void);
20
21
22       int wnoutrefresh(WINDOW *win);
23
24
25       int wrefresh(WINDOW *win);
26
27

DESCRIPTION

29       The  refresh()  and  wrefresh() functions copy stdscr and  win, respec‐
30       tively, to the terminal screen. These functions call the wnoutrefresh()
31       function  to  copy  the  specified  window to curscr and the doupdate()
32       function to do the  actual update.  The physical cursor  is  mapped  to
33       the  same  position as the logical cursor of  the last window to update
34       curscr unless leaveok(3XCURSES) is enabled  (in which case, the  cursor
35       is placed in a position that X/Open Curses finds  convenient).
36
37
38       When  outputting several windows at once, it is often more efficient to
39       call the wnoutrefresh() and doupdate() functions directly.  A  call  to
40       wnoutrefresh()  for  each  window,  followed by only one call  to doup‐
41       date() to update the screen, results in one  burst  of  output,   fewer
42       characters sent, and less CPU time used.
43
44
45       If  the win parameter to wrefresh() is the global variable  curscr, the
46       screen is immediately cleared and repainted from scratch.
47
48
49       For details on how  the  wnoutrefresh()  function  handles  overlapping
50       windows  with  broad glyphs, see the Overlapping Windows section of the
51       curses(3XCURSES) reference manual page.
52

PARAMETERS

54       win    Is a pointer to the window in which to refresh.
55
56

RETURN VALUES

58       On success, these functions return OK. Otherwise, they return ERR.
59

ERRORS

61       None.
62

ATTRIBUTES

64       See attributes(5) for descriptions of the following attributes:
65
66
67
68
69       ┌─────────────────────────────┬─────────────────────────────┐
70       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
71       ├─────────────────────────────┼─────────────────────────────┤
72       │Interface Stability          │Standard                     │
73       ├─────────────────────────────┼─────────────────────────────┤
74       │MT-Level                     │Unsafe                       │
75       └─────────────────────────────┴─────────────────────────────┘
76