X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=297aaa482d0d8815b378bcd13dc1a0d9a9925fca;hp=2af744e20b6b8e14db0582830a1e1b02579f6df1;hb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 2af744e2..297aaa48 100644 --- a/doc/html/man/curs_inchstr.3x.html +++ b/doc/html/man/curs_inchstr.3x.html @@ -1,7 +1,6 @@ - +
+ +- -curs_inchstr(3x) curs_inchstr(3x) +curs_inchstr(3x) curs_inchstr(3x) --
- inchstr, inchnstr, winchstr, winchnstr, mvinchstr, - mvinchnstr, mvwinchstr, mvwinchnstr - get a string of +
+ inchstr, inchnstr, winchstr, winchnstr, mvinchstr, + mvinchnstr, mvwinchstr, mvwinchnstr - get a string of characters (and attributes) from a curses window --
+
#include <curses.h> int inchstr(chtype *chstr); @@ -67,8 +65,7 @@ int n); --
+
These routines return a NULL-terminated array of chtype quantities, starting at the current cursor position in the named window and ending at the right margin of the window. @@ -80,43 +77,59 @@ the chstr [see curs_inch(3x)]. --
+
All routines return the integer ERR upon failure and an integer value other than ERR upon successful completion (the number of characters retrieved, exclusive of the trailing 0). + X/Open Curses defines no error conditions. In this imple- + mentation: --
- Note that all routines except winchnstr may be macros. - SVr4 does not document whether the result string is 0-ter- - minated; it does not document whether a length limit argu- - ment includes any trailing 0; and it does not document the - meaning of the return value. + o If the win parameter is null, an error is returned, + o If the chstr parameter is null, an error is returned, --
- These functions are described in the XSI Curses standard, - Issue 4. It is no more specific than the SVr4 documenta- + 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 winchnstr may be macros. + SVr4 does not document whether the result string is zero- + terminated; it does not document whether a length limit + argument includes any trailing 0; and it does not document + the meaning of the return value. + + +
+ These functions are described in the XSI Curses standard, + Issue 4. It is no more specific than the SVr4 documenta- tion on the trailing 0. It does specify that the success- ful return of the functions is OK. --
+
curses(3x), curs_inch(3x). + Comparable functions in the wide-character (ncursesw) li- + brary are described in curs_in_wchstr(3x). + - curs_inchstr(3x) + curs_inchstr(3x)-