'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
.TH copywin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
copywin \- overlay or overwrite any portion of window
.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 \fBcopywin\fR(\fBconst WINDOW *\fR\fIsrcwin\fR, \fBWINDOW *\fR\fIdstwin\fR, \fBint\fR \fIsminrow\fR, \fBint\fR \fIsmincol\fR,
     \fBint\fR \fIdminrow\fR, \fBint\fR \fIdmincol\fR, \fBint\fR \fIdmaxrow\fR, \fBint\fR \fIdmaxcol\fR, \fBint\fR \fIoverlay\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIsrcwin\fR\fR
.ad
.RS 11n
.rt  
Is a pointer to the source window to be copied.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdstwin\fR\fR
.ad
.RS 11n
.rt  
Is a pointer to the destination window to be overlayed or overwritten.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsminrow\fR\fR
.ad
.RS 11n
.rt  
Is the row coordinate of the upper left corner of the rectangular area  on the source window to be copied.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsmincol\fR\fR
.ad
.RS 11n
.rt  
Is the column coordinate of the upper left corner of the rectangular area  on the source window to be copied.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdminrow\fR\fR
.ad
.RS 11n
.rt  
Is the row coordinate of the upper left corner of the rectangular area  on the destination window to be overlayed or overwritten.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdmincol\fR\fR
.ad
.RS 11n
.rt  
Is the column coordinate of the upper left corner of the rectangular area  on destination window to be overlayed or overwritten.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdmaxrow\fR\fR
.ad
.RS 11n
.rt  
Is the row coordinate of the lower right corner of the rectangular area  on the destination window to be overlayed or overwritten.
.RE

.sp
.ne 2
.mk
.na
\fB\fIdmaxcol\fR\fR
.ad
.RS 11n
.rt  
Is the column coordinate of the lower right corner of the rectangular area  on the destination window to be overlayed or overwritten.
.RE

.sp
.ne 2
.mk
.na
\fB\fIoverlay\fR\fR
.ad
.RS 11n
.rt  
Is a \fBTRUE\fR or \fBFALSE\fR value that determines whether the destination  window is overlayed or overwritten.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBcopywin()\fR function provides a finer granularity of control over the \fBoverlay\fR(3XCURSES) and \fBoverwrite\fR(3XCURSES) functions. As in the \fBprefresh()\fR function (see \fBnewpad\fR(3XCURSES)), a rectangle is specified in the destination window, (\fIdminrow\fR, \fIdmincol\fR) and (\fIdmaxrow\fR, \fIdmaxcol\fR), and the upper-left-corner coordinates of the source window, (\fIsmincol\fR, \fIsminrow\fR). If \fIoverlay\fR is \fBTRUE\fR, then copying is non-destructive, as in \fBoverlay()\fR. If \fIoverlay\fR is \fBFALSE\fR, then copying is destructive, as in \fBoverwrite()\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, the \fBcopywin()\fR function returns \fBOK\fR. Otherwise, it returns \fBERR\fR.
.SH ERRORS
.sp
.LP
No errors are defined.
.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
\fBcurses\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewpad\fR(3XCURSES), \fBoverlay\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)