X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=f223394a3b118586e75444cb0beed9e932b3f226;hp=b22f5674c6ca47838632bf8a7ed92cce138a1596;hb=HEAD;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index b22f5674..511e1dc1 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,6 +1,7 @@ - -curs_instr 3x - - +curs_instr 3x 2024-04-20 ncurses 6.4 Library calls + + -

curs_instr 3x

curs_instr 3x 2024-04-20 ncurses 6.4 Library calls

-curs_instr(3x)                                                  curs_instr(3x)
+curs_instr(3x)                   Library calls                  curs_instr(3x)

NAME

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

SYNOPSIS

        #include <curses.h>
 
-       int instr(char *str);
-       int innstr(char *str, int n);
-       int winstr(WINDOW *win, char *str);
-       int winnstr(WINDOW *win, char *str, int n);
-       int mvinstr(int y, int x, char *str);
-       int mvinnstr(int y, int x, char *str, int n);
-       int mvwinstr(WINDOW *win, int y, int x, char *str);
-       int mvwinnstr(WINDOW *win, int y, int x, char *str, int n);
+       int instr(char *str);
+       int innstr(char *str, int n);
+       int winstr(WINDOW *win, char *str);
+       int winnstr(WINDOW *win, char *str, int n);
+
+       int mvinstr(int y, int x, char *str);
+       int mvinnstr(int y, int x, char *str, int n);
+       int mvwinstr(WINDOW *win, int y, int x, char *str);
+       int mvwinnstr(WINDOW *win, int y, int x, char *str, int n);

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 characters.  The four functions with n  as  the  last
-       argument  return  a leading substring at most n characters long (exclu-
-       sive of the trailing NUL).
+       These routines return a string of characters in str,  starting  at  the
+       current  cursor  position in the named window.  Attributes are stripped
+       from the characters.
+
+       The four functions with  n  as  the  last  argument  return  a  leading
+       substring  at  most  n characters long (exclusive of the trailing NUL).
+       Transfer stops at the end of the current line,  or  when  n  characters
+       have been stored at the location referenced by str.

RETURN VALUE

-       All of the functions return ERR upon failure, or the number of  charac-
-       ters actually read into the string.
+       All  of  the  functions  return  ERR  upon  failure,  or  the number of
+       characters actually read into the string.
 
-       X/Open Curses defines no error conditions.  In this implementation:
+       X/Open Curses defines no error conditions.  This implementation returns
+       an error
 
-       o   If the win parameter is null, an error is returned,
+       o   if the win parameter is null or
 
-       o   If the chstr parameter is null, an error is returned,
+       o   if the chstr parameter is null.
 
-       Functions  with  a  "mv"  prefix  first perform a cursor movement using
-       wmove, and return an error if the position is outside the window, or if
-       the window pointer is null.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

-       Note that all routines except winnstr may be macros.
+       All routines except winnstr may be macros.
+
+       Reading a line that overflows the array pointed to by str  with  instr,
+       mvinstr,  mvwinstr  or winstr causes undefined results.  Therefore, the
+       use of innstr, mvinnstr, mvwinnstr, or winnstr is recommended.

PORTABILITY

-       SVr4  does not document whether a length limit includes or excludes the
+       SVr4 does not document whether a length limit includes or excludes  the
        trailing NUL.
 
-       The ncurses library extends the XSI description by allowing a  negative
-       value  for  n.  In this case, the functions return the string ending at
-       the right margin.
+       The ncurses library extends the X/Open Curses description by allowing a
+       negative value for n.  In this case, the functions  return  the  string
+       ending at the right margin.