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=da74fd1aa79a9e64b82049d71d6ecf84e9ce5df0;hb=HEAD;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index da74fd1a..50d0f20e 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) Library calls 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 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 - (exclusive 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.
- 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. This implementation returns + an error - 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. + o if the win parameter is null or - 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 chstr parameter is null. + + Functions prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries.
- 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.
- 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 X/Open Curses description by allowing a + negative value for n. In this case, the functions return the string + ending at the right margin.
- curses(3x). + curs_ins_wstr(3x) describes comparable functions of the ncurses library + in its wide-character configuration (ncursesw). + + curses(3x), curs_inch(3x), curs_inchstr(3x) - curs_instr(3x) +ncurses 6.5 2024-04-20 curs_instr(3x)