X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getstr.3x.html;h=8f42e1f57df3ad7f4d60588034063f7b8b9ba76a;hp=206b64e1d6151005e6781c542368ae8757e25a9d;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86 diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html index 206b64e1..8f42e1f5 100644 --- a/doc/html/man/curs_getstr.3x.html +++ b/doc/html/man/curs_getstr.3x.html @@ -1,6 +1,6 @@ @@ -45,15 +45,13 @@ - -
+
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. @@ -112,18 +108,16 @@ 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- plementation returns ERR if the window pointer is null, or - if the lower-level wgetch call returns an ERR. + if the lower-level wgetch(3x) call returns an ERR. SVr3 and early SVr4 curses implementations did not reject function keys; the SVr4.0 documentation claimed that "spe- @@ -138,8 +132,7 @@ present but not documented in SVr4. --
+
curses(3x), curs_getch(3x), curs_variables(3x).