X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getstr.3x.html;h=f5f9d07083a37fd35d58ad6d7909cecc2f18894d;hp=066f81bcb95a29a8873b2e6ad17a8e280b097466;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html index 066f81bc..f5f9d070 100644 --- a/doc/html/man/curs_getstr.3x.html +++ b/doc/html/man/curs_getstr.3x.html @@ -1,7 +1,7 @@
@@ -40,15 +40,15 @@-curs_getstr(3x) curs_getstr(3x) +curs_getstr(3x) curs_getstr(3x)
- getstr, getnstr, wgetstr, wgetnstr, mvgetstr, mvgetnstr, - mvwgetstr, mvwgetnstr - accept character strings from + getstr, getnstr, wgetstr, wgetnstr, mvgetstr, mvgetnstr, + mvwgetstr, mvwgetnstr - accept character strings from curses terminal keyboard @@ -71,15 +71,15 @@ The function getstr is equivalent to a series of calls to getch, until a newline or carriage return is received (the terminating character is not included in the returned - string). The resulting value is placed in the area - pointed to by the character pointer str. + string). The resulting value is placed in the area point- + ed to by the character pointer str. wgetnstr reads at most n characters, thus preventing a - possible overflow of the input buffer. Any attempt to - enter more characters (other than the terminating newline - or carriage return) causes a beep. Function keys also - cause a beep and are ignored. The getnstr function reads - from the stdscr default window. + possible overflow of the input buffer. Any attempt to en- + ter more characters (other than the terminating newline or + carriage return) causes a beep. Function keys also cause + a beep and are ignored. The getnstr function reads from + the stdscr default window. The user's erase and kill characters are interpreted. If keypad mode is on for the window, KEY_LEFT and @@ -97,6 +97,16 @@ (SVr4 specifies only "an integer value other than ERR") upon successful completion. + X/Open defines no error conditions. + + In this implementation, these functions return an error if + the window pointer is null, or if its timeout expires + without having any data. + + This implementation provides an extension as well. If a + SIGWINCH interrupts the function, it will return KEY_RE- + SIZE rather than OK or ERR. +
@@ -107,9 +117,9 @@PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. They read single-byte characters only. The - standard does not define any error conditions. This - implementation returns ERR if the window pointer is null, - or if the lower-level wgetch call returns an ERR. + standard does not define any error conditions. This im- + plementation returns ERR if the window pointer is null, or + if the lower-level wgetch call returns an ERR. SVr3 and early SVr4 curses implementations did not reject function keys; the SVr4.0 documentation claimed that "spe- @@ -120,8 +130,8 @@ useful (being, in fact, the low-order eight bits of the key's KEY_ value). - The functions getnstr, mvgetnstr, and mvwgetnstr were pre- - sent but not documented in SVr4. + The functions getnstr, mvgetnstr, and mvwgetnstr were + present but not documented in SVr4.@@ -130,7 +140,7 @@ - curs_getstr(3x) + curs_getstr(3x)