X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=da74fd1aa79a9e64b82049d71d6ecf84e9ce5df0;hp=3bd43e81190a5c12363602c1f1779ac289426850;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 3bd43e81..da74fd1a 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

-
+

curs_instr 3x

-
+curs_instr(3x)                                           curs_instr(3x)
 
-
-

NAME

+
+
+
+

NAME

        instr,  innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin-
        str, mvwinnstr - get a string of characters from a  curses
        window
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
        int instr(char *str);
@@ -63,8 +65,7 @@
        n);
 
 
-
-

DESCRIPTION

+

DESCRIPTION

        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-
@@ -73,46 +74,49 @@
        (exclusive of the trailing NUL).
 
 
-
-

RETURN VALUE

+

RETURN VALUE

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

NOTES

-       Note that all routines except winnstr may be macros.
-
-
-
-

PORTABILITY

-       The XSI Curses error  conditions  EILSEQ  and  EILOVERFLOW
-       associated  with  extended-level  conformance  are not yet
-       detected (this implementation does not  yet  support  XPG4
-       multibyte  characters).   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
-       return the string ending at the right margin.
+       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.
 
 
-
-

SEE ALSO

-       curses(3x).
+

NOTES

+       Note that all routines except winnstr may be macros.
 
 
+

PORTABILITY

+       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
+       return the string ending at the right margin.
 
 
+

SEE ALSO

+       curses(3x).
 
 
 
+                                                         curs_instr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +