X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_getstr.3x.html;h=0141f63dca27e801244432d019f02ad8c9f1667e;hb=56f1e8cd80dfb926f74e1739bf969489b0cfa56f;hp=fd264d281040583ad54cefeb1491e8d4f628b0c6;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html index fd264d28..0141f63d 100644 --- a/doc/html/man/curs_getstr.3x.html +++ b/doc/html/man/curs_getstr.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_getstr(3x) curs_getstr(3x) --
+
getstr, getnstr, wgetstr, wgetnstr, mvgetstr, mvgetnstr, mvwgetstr, mvwgetnstr - accept character strings from curses terminal keyboard --
+
#include <curses.h> int getstr(char *str); @@ -66,8 +64,7 @@ int mvwgetnstr(WINDOW *, int y, int x, char *str, int n); --
+
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 @@ -91,8 +88,7 @@ vious character (typically a left motion). --
+
All routines return the integer ERR upon failure and an OK (SVr4 specifies only "an integer value other than ERR") upon successful completion. @@ -103,14 +99,20 @@ 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. --
+ Functions with a "mv" prefix first perform a cursor move- + ment using wmove, and return an error if the position is + outside the window, or if the window pointer is null. + + +
Note that getstr, mvgetstr, and mvwgetstr may be macros. --
+
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 im- @@ -130,18 +132,23 @@ present but not documented in SVr4. --
- curses(3x), curs_getch(3x). +
+ curses(3x), curs_getch(3x), curs_variables(3x). curs_getstr(3x)-