usr/src/man/man3xcurses/notimeout.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 NOTIMEOUT 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 notimeout, timeout, wtimeout \- set timed 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 \fBnotimeout\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBtimeout\fR(\fBint\fR \fIdelay\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBvoid\fR \fBwtimeout\fR(\fBWINDOW\fR \fIwin\fR, \fBint\fR \fIdelay\fR);
  30 .fi
  31
  32 .SH PARAMETERS
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fIwin\fR\fR
  37 .ad
  38 .RS 9n
  39 Is a pointer to the window in which to set the timed blocking.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fIbf\fR\fR
  46 .ad
  47 .RS 9n
  48 Is a Boolean expression.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIdelay\fR\fR
  55 .ad
  56 .RS 9n
  57 Is the number of milliseconds to block or wait for input.
  58 .RE
  59
  60 .SH DESCRIPTION
  61 .sp
  62 .LP
  63 If \fIbool\fR is \fBTRUE\fR, the \fBnotimeout()\fR function disables a  timer
  64 used by \fBgetch\fR(3XCURSES) when handling multibyte function key sequences.
  65 .sp
  66 .LP
  67 When \fIbool\fR is \fBFALSE\fR and keypad handling is enabled, a timer is  set
  68 by \fBgetch()\fR to handle bytes received that could be the beginning of a
  69 function key (for example, ESC). If the remainder of the sequence is not
  70 received before the time expires, the  first byte is returned; otherwise, the
  71 value of the function key is returned. Subsequent calls to the \fBgetch()\fR
  72 function will return the other bytes received for the incomplete key sequence.
  73 .sp
  74 .LP
  75 The \fBtimeout()\fR and \fBwtimeout()\fR functions set the length of time
  76 \fBgetch()\fR waits for input for windows \fBstdscr\fR and \fIwin\fR,
  77 respectively.  These functions are similar to \fBnodelay\fR(3XCURSES) except
  78 the time to block  or wait for input can be specified.
  79 .sp
  80 .LP
  81 A negative \fIdelay\fR causes the program to wait indefinitely for input; a
  82 \fIdelay\fR of \fB0\fR returns \fBERR\fR if no input is ready; and  a positive
  83 \fIdelay\fR blocks until input arrives or the time specified expires, (in which
  84 case, \fBERR\fR is returned).
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 On success, the \fBnotimeout()\fR function returns \fBOK\fR. Otherwise, it
  89 returns \fBERR\fR.
  90 .sp
  91 .LP
  92 The \fBtimeout()\fR and \fBwtimeout()\fR functions do not return a value.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 None.
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Standard
 111 _
 112 MT-Level        Unsafe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
 119 \fBnodelay\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)