X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inchstr.3x.html;h=2eb84bc7e4a17f855182c57f2a3b0c5df642bb92;hp=3b0cbbe4de69a8c38289744b35e94e21a1661f0b;hb=c885a3fdd089f784f17dd2e9c03d8eb774072dc9;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/curs_inchstr.3x.html b/doc/html/man/curs_inchstr.3x.html index 3b0cbbe4..2eb84bc7 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)                                       curs_inchstr(3x)
 
 
 
 
-
-

NAME

+

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);
@@ -67,8 +65,7 @@
        int n);
 
 
-
-

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.
@@ -80,8 +77,7 @@
        the chstr [see curs_inch(3x)].
 
 
-
-

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
@@ -91,36 +87,46 @@
        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-
        ful return of the functions is OK.
 
 
-
-

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 -
+
+ +