X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=b783e98fce9386c3b8fa3b7b9ae43a708de2b5df;hb=91d451ffc473b358d8d74506d2da8871e44fbd7b;hp=9012f5ebf8c8828f22a073a59aec14f1e9068bcf;hpb=8e397cccba0aad135cb9a8a353756f4273a7cdf6;p=ncurses.git diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 9012f5eb..b783e98f 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) +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); - 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);
- 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 + 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 (exclusive 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 + characters actually read into the string. - X/Open Curses defines no error conditions. In this imple- - mentation: + X/Open Curses defines no error conditions. In this implementation: 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 move- - ment using wmove, and return an error if the position is - outside the window, or if the window pointer 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.
@@ -95,12 +93,12 @@
- 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.
@@ -108,7 +106,7 @@ - curs_instr(3x) + curs_instr(3x)