X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=e63a980b2d55003702496c84927764733b435b36;hp=16c40ded4798e92776af53c606d11e067866dd38;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86
diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html
index 16c40ded..e63a980b 100644
--- a/doc/html/man/curs_instr.3x.html
+++ b/doc/html/man/curs_instr.3x.html
@@ -1,6 +1,6 @@
@@ -40,20 +40,17 @@
-curs_instr(3x) curs_instr(3x)
+curs_instr(3x) curs_instr(3x)
-
-
- instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin-
- str, mvwinnstr - get a string of characters from a curses
- window
+
+ instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr
+ - get a string of characters from a curses window
-
-
+
#include <curses.h>
int instr(char *str);
@@ -63,56 +60,51 @@
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 mvwinnstr(WINDOW *win, int y, int x, char *str, int n);
-
-
- 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-
- ters. The four functions with n as the last argument
- return a leading substring at most n characters long
- (exclusive of the trailing NUL).
+
+ 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).
-
-
- All of the functions return ERR upon failure, or the num-
- ber of characters actually read into the string.
+
+ All of the functions return ERR upon failure, or the number of charac-
+ ters 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.
+ X/Open Curses defines no error conditions. In this implementation:
- 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.
+ o If the win parameter is null, an error is returned,
+ o If the chstr parameter is null, an error is returned,
-
-
+ 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.
+
+
+
Note that all routines except winnstr may be macros.
-
-
- SVr4 does not document whether a length limit includes or
- excludes the trailing NUL.
+
+ 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.
+ 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.
-
-
+
curses(3x).
- curs_instr(3x)
+ curs_instr(3x)