X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_instr.3x.html;h=f5aecfcbead5d177f51be315aa39f2a758cd3aa2;hp=3bd43e81190a5c12363602c1f1779ac289426850;hb=a90dd7b66fa711acd24d8181ea20e4f57d4b36cd;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_instr.3x.html b/doc/html/man/curs_instr.3x.html index 3bd43e81..f5aecfcb 100644 --- a/doc/html/man/curs_instr.3x.html +++ b/doc/html/man/curs_instr.3x.html @@ -1,7 +1,7 @@ - +
+ +- +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); @@ -59,60 +61,62 @@ 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 Curses defines no error conditions. In this implementation: --
- Note that all routines except winnstr may be macros. - + o If the win parameter is null, an error is returned, --
- The XSI Curses error conditions EILSEQ and EILOVERFLOW - associated with extended-level conformance are not yet - detected (this implementation does not yet support XPG4 - multibyte characters). SVr4 does not document whether a - length limit includes or excludes the trailing NUL. + o If the chstr parameter is null, an error is returned, - 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. + 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. --
- curses(3x). +
+ 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)-