'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH syncok 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
syncok, wcursyncup, wsyncdown, wsyncup \- synchronize window with its parents or children
.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 \fBsyncok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
.fi

.LP
.nf
\fBvoid\fR \fBwcursyncup\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.LP
.nf
\fBvoid\fR \fBwsyncdown\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.LP
.nf
\fBvoid\fR \fBwsyncup\fR(\fBWINDOW *\fR\fIwin\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to a window.
.RE

.sp
.ne 2
.mk
.na
\fB\fIbf\fR\fR
.ad
.RS 7n
.rt  
Is a Boolean expression.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBsyncok()\fR function uses the value of \fIbf\fR to determine  whether or not the window \fIwin\fR's ancestors are implicitly touched whenever there is a change to \fIwin\fR. If \fIbf\fR is \fBTRUE\fR, this touching occurs. If \fIbf\fR is \fBFALSE\fR, it does not occur. The initial value for \fIbf\fR is \fBFALSE\fR.
.sp
.LP
The \fBwcursyncup()\fR function moves the cursor in \fIwin\fR's ancestors  to match its position in \fIwin\fR.
.sp
.LP
The \fBwsyncdown()\fR function touches \fIwin\fR if any of its ancestors have been touched.
.sp
.LP
The \fBwsyncup()\fR function touches all ancestors of \fIwin\fR.
.SH RETURN VALUES
.sp
.LP
On success, the \fBsyncok()\fR function returns \fBOK\fR. Otherwise, it returns \fBERR\fR.
.sp
.LP
The other functions do not return a value.
.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
\fBderwin\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBis_linetouched\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)