X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_getstr.3x.html;h=61ebd5466726fd48aa8a8c8cca12c8b670eca4ec;hp=f7cffded9a17c78d83147ad30d2b11faa4a0bf26;hb=ce4803687b821efbc5fb2c5a5f06d69cd4dc2656;hpb=761e4f0825b330e970558e82a4bd638383914429;ds=sidebyside diff --git a/doc/html/man/curs_getstr.3x.html b/doc/html/man/curs_getstr.3x.html index f7cffded..61ebd546 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. @@ -112,24 +108,22 @@ 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- cial keys" (such as function keys, "home" key, "clear" key, etc.) are "interpreted", without giving details. It - lied. In fact, the `character' value appended to the + lied. In fact, the "character" value appended to the string by those implementations was predictable but not useful (being, in fact, the low-order eight bits of the key's KEY_ value). @@ -138,18 +132,23 @@ present but not documented in SVr4. --
+
curses(3x), curs_getch(3x), curs_variables(3x). curs_getstr(3x)-