X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=b231595073290765799be8fe3a23dfa0da399596;hp=cdf33a2a5793e3690ad4c8fd783cd2533f417f52;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index cdf33a2a..b2315950 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) + + +-
- inchstr, inchnstr, winchstr, winchnstr, mvinchstr, - mvinchnstr, mvwinchstr, mvwinchnstr - get a string of +NAME
+ inchstr, inchnstr, winchstr, winchnstr, mvinchstr, + mvinchnstr, mvwinchstr, mvwinchnstr - get a string of characters (and attributes) from a curses window-SYNOPSIS
+SYNOPSIS
#include <curses.h> int inchstr(chtype *chstr); @@ -64,7 +68,7 @@-DESCRIPTION
+DESCRIPTION
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. @@ -77,24 +81,32 @@-RETURN VALUE
+RETURN VALUE
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). + No error conditions are defined. If the chstr parameter + is null, no data is returned, and the return value is ze- + ro. + + 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. +-NOTES
+NOTES
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. + 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.-PORTABILITY
+PORTABILITY
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- @@ -102,17 +114,26 @@-SEE ALSO
+SEE ALSO
curses(3x), curs_inch(3x). + Comparable functions in the wide-character (ncursesw) li- + brary are described in curs_in_wchstr(3x). + curs_inchstr(3x)-
- -Man(1) output converted with -man2html - +