usr/src/man/man3xcurses/nodelay.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH NODELAY 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 nodelay \- set blocking or non-blocking read
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBnodelay\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIwin\fR\fR
  27 .ad
  28 .RS 7n
  29 Is a pointer to the window in which to enable non-blocking.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIbf\fR\fR
  36 .ad
  37 .RS 7n
  38 Is a Boolean expression.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 If enabled, (\fIbf\fR is \fBTRUE\fR), the \fBnodelay()\fR function causes
  45 \fBgetch\fR(3XCURSES) to return \fBERR\fR if no input is ready.  When disabled,
  46 \fBgetch()\fR blocks until a key is pressed.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 On success, the \fBnodelay()\fR function returns \fBOK\fR. Otherwise, it
  51 returns \fBERR\fR.
  52 .SH ERRORS
  53 .sp
  54 .LP
  55 None.
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5) for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 Interface Stability     Standard
  70 _
  71 MT-Level        Unsafe
  72 .TE
  73
  74 .SH SEE ALSO
  75 .sp
  76 .LP
  77 \fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  78 \fBnotimeout\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)