X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=9012f5ebf8c8828f22a073a59aec14f1e9068bcf;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hp=8ba394a585f28c8933556326878cf51c3ceb9654;hpb=b0b1980be11bba618d84beb8b30ac94e2c820602;p=ncurses.git diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 8ba394a5..9012f5eb 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_instr(3x) curs_instr(3x) --
+
instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin- str, mvwinnstr - get a string of characters from a curses window --
+
#include <curses.h> int instr(char *str); @@ -67,8 +65,7 @@ n); --
+
These routines return a string of characters in str, extracted starting at the current cursor position in the named window. Attributes are stripped from the charac- @@ -77,44 +74,52 @@ (exclusive of the trailing NUL). --
+
All of the functions return ERR upon failure, or the num- ber of characters actually read into the string. - X/Open defines no error conditions. In this implementa- - tion, if the window parameter is null or the str parameter - is null, a zero is returned. + X/Open Curses defines no error conditions. In this imple- + mentation: - Functions with a "mv" prefix first perform a cursor move- - ment using wmove, and return an error if the position is + o If the win parameter is null, an error is returned, + + o If the chstr parameter is null, an error is returned, + + 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 all routines except winnstr may be macros. --
- SVr4 does not document whether a length limit includes or +
+ SVr4 does not document whether a length limit includes or excludes the trailing NUL. - The ncurses library extends the XSI description by allow- - ing a negative value for n. In this case, the functions + The ncurses library extends the XSI description by allow- + ing a negative value for n. In this case, the functions return the string ending at the right margin. --
+
curses(3x). curs_instr(3x)-