Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
notimeout(3XCURSES)	X/Open Curses Library Functions	   notimeout(3XCURSES)

NAME
       notimeout, timeout, wtimeout - set timed	blocking or non-blocking read

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
       -R /usr/xpg4/lib	-lcurses [ library... ]

       c89 [ flag... ] file... -lcurses	[ library... ]

       #include	<curses.h>

       int notimeout(WINDOW *win, bool bf);

       void timeout(int	delay);

       void wtimeout(WINDOW win, int delay);

PARAMETERS
       win		       Is  a pointer to	the window in which to set the
			       timed blocking.

       bf		       Is a Boolean expression.

       delay		       Is the number of	milliseconds to	block or  wait
			       for input.

DESCRIPTION
       If  bool	 is  TRUE,  the	notimeout() function disables a	 timer used by
       getch(3XCURSES) when handling multibyte function	key sequences.

       When bool is FALSE and keypad handling is enabled, a timer is   set  by
       getch() to handle bytes received	that could be the beginning of a func-
       tion key	(for example, ESC). If the remainder of	the  sequence  is  not
       received	 before	 the time expires, the	first byte is returned;	other-
       wise, the value of the function key is returned.	 Subsequent  calls  to
       the  getch()  function will return the other bytes received for the in-
       complete	key sequence.

       The timeout() and wtimeout() functions set the length of	time   getch()
       waits for input for windows stdscr and win,  respectively.  These func-
       tions are similar to nodelay(3XCURSES) except the  time	to  block   or
       wait for	input can be specified.

       A  negative  delay causes the program to	wait indefinitely for input; a
       delay of	0 returns ERR if no input is  ready;  and   a  positive	 delay
       blocks until input arrives or the time specified
	expires, (in which case, ERR is	returned).

RETURN VALUES
       On  success, the	notimeout() function returns OK. Otherwise, it returns
       ERR.

       The timeout() and wtimeout() functions do not return a value.

ERRORS
       None.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       getch(3XCURSES),	  halfdelay(3XCURSES),	 libcurses(3XCURSES),	 node-
       lay(3XCURSES), attributes(5), standards(5)

SunOS 5.10			  5 Jun	2002		   notimeout(3XCURSES)

NAME | SYNOPSIS | PARAMETERS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=timeout&sektion=3xcurses&manpath=SunOS+5.10>

home | help