notimeout(3curses)

notimeout -- control blocking on input

Synopsis

cc [options] file -lcurses

#include <curses.h>

int notimeout(WINDOW *win, bool bf);

void timeout(int delay);

void wtimeout(WINDOW *win, int delay);

Description

The notimeout(3curses) function specifies whether Timeout Mode or No Timeout Mode is in effect for the screen associated with the specified window. If bf is TRUE, this screen is set to No Timeout Mode. If bf is FALSE, this screen is set to Timeout Mode. The initial state is FALSE.

The timeout(3curses) and wtimeout(3curses) functions set blocking or non-blocking read for the current or specified window based on the value of delay:

delay < 0: One or more blocking reads (indefinite waits for input) are used.
delay = 0: One or more non-blocking reads are used. Any Curses input function will fail if every character of the requested string is not immediately available.
delay > 0: Any Curses input function blocks for delay milliseconds and fails if there is still no input.

Return value

Upon successful completion, the notimeout(3curses) function returns OK. Otherwise, it returns ERR.

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

Errors

No errors are defined.

Standards Conformance

The Single UNIX Specification, Version 2; The Open Group.

References

``Input Processing'', getch(3curses), halfdelay(3curses), nodelay(3curses), curses(4), termio(7)