X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=1cef7787e66d3d1ddb34dc5937eb3cfe0824c3a7;hp=a560ae6e77164537e228e376bdc14389d60a50ce;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index a560ae6e..1cef7787 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,7 +1,6 @@ - + + + curs_instr 3x @@ -39,21 +41,20 @@

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);
@@ -68,7 +69,7 @@
 
 
 
-

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-
@@ -78,42 +79,52 @@
 
 
 
-

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

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

+

SEE ALSO

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