X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=1cef7787e66d3d1ddb34dc5937eb3cfe0824c3a7;hp=30746395a1d5374c37aa2af202d57b2b9f712ecd;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;ds=sidebyside diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 30746395..1cef7787 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,80 +1,130 @@ + + +
+ + +- +curs_instr(3x) curs_instr(3x) + + +-
- instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin- - str, mvwinnstr - get a string of characters from a curses +NAME
+ instr, innstr, winstr, winnstr, mvinstr, mvinnstr, mvwin- + str, mvwinnstr - get a string of characters from a curses window-SYNOPSIS
- #include <curses.h> +SYNOPSIS
+ #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);-DESCRIPTION
- These routines return a string of characters in str, +DESCRIPTION
+ 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 + ters. The four functions with n as the last argument + return a leading substring at most n characters long (exclusive of the trailing NUL).-RETURN VALUE
- All of the functions return ERR upon failure, or the num- +RETURN VALUE
+ All of the functions return ERR upon failure, or the num- ber of characters 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. --NOTES
- Note that all routines except winnstr may be macros. + 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.-PORTABILITY
- 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. - - 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. +NOTES
+ Note that all routines except winnstr may be macros.-SEE ALSO
- curses(3x). - - +PORTABILITY
+ 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. ++SEE ALSO
+ curses(3x). + curs_instr(3x)-
- -Man(1) output converted with -man2html - +