xref: /illumos-gate/usr/src/man/man3xcurses/doupdate.3xcurses (revision 6bb6b5762ca4b17cd5fb3c6c123f17489d5635aa)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
DOUPDATE 3XCURSES "Jun 5, 2002"
NAME
doupdate, refresh, wnoutrefresh, wrefresh - refresh windows and lines
SYNOPSIS

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

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int doupdate(void);

int refresh(void);

int wnoutrefresh(WINDOW *win);

int wrefresh(WINDOW *win);
DESCRIPTION

The refresh() and wrefresh() functions copy stdscr and win, respectively, to the terminal screen. These functions call the wnoutrefresh() function to copy the specified window to curscr and the doupdate() function to do the actual update. The physical cursor is mapped to the same position as the logical cursor of the last window to update curscr unless leaveok(3XCURSES) is enabled (in which case, the cursor is placed in a position that X/Open Curses finds convenient).

When outputting several windows at once, it is often more efficient to call the wnoutrefresh() and doupdate() functions directly. A call to wnoutrefresh() for each window, followed by only one call to doupdate() to update the screen, results in one burst of output, fewer characters sent, and less CPU time used.

If the win parameter to wrefresh() is the global variable curscr, the screen is immediately cleared and repainted from scratch.

For details on how the wnoutrefresh() function handles overlapping windows with broad glyphs, see the Overlapping Windows section of the curses(3XCURSES) reference manual page.

PARAMETERS
win

Is a pointer to the window in which to refresh.

RETURN VALUES

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

ERRORS

None.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

clearok(3XCURSES), curses(3XCURSES), libcurses(3XCURSES), prefresh(3XCURSES), redrawwin(3XCURSES), attributes(5), standards(5)