* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_getch.3x,v 1.47 2016/06/11 22:56:33 tom Exp @
+ * @Id: curs_getch.3x,v 1.49 2016/10/15 16:44:01 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
real key:
<STRONG>o</STRONG> <STRONG>KEY_RESIZE</STRONG> is returned when the <STRONG>SIGWINCH</STRONG> signal has
- been detected (see <STRONG><A HREF="curs_initscr.3x.html">
curs_initscr(3x)</A></STRONG> and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>).
+ been detected (see <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> and <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>).
This code is returned whether or not <STRONG>keypad</STRONG> has been
enabled.
<STRONG>o</STRONG> <STRONG>KEY_MOUSE</STRONG> is returned for mouse-events (see
<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>). This code relies upon whether or not
- <STRONG><A HREF="keypad.3x.html">keypad(3x)</A></STRONG> has been enabled, because (e.g., with <EM>xterm</EM>
+ <STRONG><A HREF="curs_inopts.3x.html">keypad(3x)</A></STRONG> has been enabled, because (e.g., with <EM>xterm</EM>
mouse prototocol) ncurses must read escape sequences,
just like a function key.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
All routines return the integer <STRONG>ERR</STRONG> upon failure and an
- integer value other than <STRONG>ERR</STRONG> (<STRONG>OK</STRONG> in the case of ungetch())
+ integer value other than <STRONG>ERR</STRONG> (<STRONG>OK</STRONG> in the case of <STRONG>ungetch</STRONG>)
upon successful completion.
<STRONG>ungetch</STRONG>
<STRONG>wgetch</STRONG>
returns ERR if the window pointer is null, or if
- its timeout expires without having any data.
+ its timeout expires without having any data, or if
+ the execution was interrupted by a signal (<STRONG>errno</STRONG>
+ will be set to <STRONG>EINTR</STRONG>).
Functions with a "mv" prefix first perform a cursor move-
ment using <STRONG>wmove</STRONG>, and return an error if the position is
Programmers concerned about portability should be prepared
for either of two cases: (a) signal receipt does not in-
terrupt <STRONG>getch</STRONG>; (b) signal receipt interrupts <STRONG>getch</STRONG> and
- causes it to return ERR with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>. Under
- the <STRONG>ncurses</STRONG> implementation, handled signals never inter-
- rupt <STRONG>getch</STRONG>.
+ causes it to return ERR with <STRONG>errno</STRONG> set to <STRONG>EINTR</STRONG>.
The <STRONG>has_key</STRONG> function is unique to <STRONG>ncurses</STRONG>. We recommend
that any code using it be conditionalized on the <STRONG>NCURS-</STRONG>
projects / ncurses.git / blobdiff