X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=99d5965777f95611d0e20e40aa83fbae944ea82b;hb=a8dfaf0998c91b39c5c0a4913987cd67ca622bff;hp=1cef7787e66d3d1ddb34dc5937eb3cfe0824c3a7;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 1cef7787..99d59657 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,6 +1,6 @@
- +-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); @@ -64,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)