'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH doupdate 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
doupdate, refresh, wnoutrefresh, wrefresh \- refresh windows and lines
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]

\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
 
#include <curses.h>

\fBint\fR \fBdoupdate\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBint\fR \fBrefresh\fR(\fBvoid\fR);
.fi

.LP
.nf
\fBint\fR \fBwnoutrefresh\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.LP
.nf
\fBint\fR \fBwrefresh\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBrefresh()\fR and \fBwrefresh()\fR functions copy \fBstdscr\fR and  \fIwin\fR, respectively, to the terminal screen. These functions call the \fBwnoutrefresh()\fR function to copy the specified  window to \fBcurscr\fR and the \fBdoupdate()\fR 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 \fBcurscr\fR unless \fBleaveok\fR(3XCURSES) is enabled  (in which case, the cursor is placed in a position that X/Open Curses finds  convenient).
.sp
.LP
When outputting several windows at once, it is often more efficient to call the \fBwnoutrefresh()\fR and \fBdoupdate()\fR functions directly.  A call to \fBwnoutrefresh()\fR for each window, followed by only one call  to \fBdoupdate()\fR to update the screen, results in one burst of output,  fewer characters sent, and less CPU time used.
.sp
.LP
If the \fIwin\fR parameter to \fBwrefresh()\fR is the global variable  \fBcurscr\fR, the screen is immediately cleared and repainted from scratch.
.sp
.LP
For details on how the \fBwnoutrefresh()\fR function handles overlapping  windows with broad glyphs, see the \fBOverlapping Windows\fR section of the  \fBcurses\fR(3XCURSES) reference manual page.
.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to the window in which to refresh.
.RE

.SH RETURN VALUES
.sp
.LP
On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
.SH ERRORS
.sp
.LP
None.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelUnsafe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBclearok\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBprefresh\fR(3XCURSES), \fBredrawwin\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)