X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=99d5965777f95611d0e20e40aa83fbae944ea82b;hp=30746395a1d5374c37aa2af202d57b2b9f712ecd;hb=fe43d506ce08d1deef9e9e5a6d5fd4f9c9c32e1d;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 30746395..99d59657 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,80 +1,121 @@ + + +
+ + +- +curs_instr(3x) curs_instr(3x) --
- instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin- - str, 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); +
+ instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwinstr, mvwinnstr + - get a string of characters from a curses window --
- 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). +
+ #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); --
- All of the functions return ERR upon failure, or the num- - ber of characters actually read into the string. +
+ 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). --
- Note that all routines except winnstr may be macros. +
+ All of the functions return ERR upon failure, or the number of charac- + ters actually read into the string. --
- The XSI Curses error conditions EILSEQ and EILOVERFLOW - associated with extended-level conformance are not yet - detected (this implementation does not yet support XPG4 - multi-byte characters). SVr4 does not document whether a - length limit includes or excludes the trailing NUL. + X/Open Curses defines no error conditions. In this implementation: - 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. + o If the win parameter is null, an error is returned, + o If the chstr parameter is null, an error is returned, --
- curses(3x). + 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. + 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)-