Current File : //usr/share/man/man3xcurses/nodelay.3xcurses

'\" te
.\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
.TH nodelay 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions"
.SH NAME
nodelay \- set blocking or non-blocking read
.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 \fBnodelay\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIwin\fR\fR
.ad
.RS 7n
.rt  
Is a pointer to the window in which to enable non-blocking.
.RE

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

.SH DESCRIPTION
.sp
.LP
If enabled, (\fIbf\fR is \fBTRUE\fR), the \fBnodelay()\fR function causes \fBgetch\fR(3XCURSES) to return \fBERR\fR if no input is ready.  When disabled, \fBgetch()\fR blocks until a key is pressed.
.SH RETURN VALUES
.sp
.LP
On success, the \fBnodelay()\fR function returns \fBOK\fR. Otherwise, it returns \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
\fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnotimeout\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)