*** UNIX MANUAL PAGE BROWSER ***

curs_inchstr(3) Library Functions Manual curs_inchstr(3) NAME curs_inchstr, inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinchstr, mvwinchnstr - Get a string of characters (and attributes) from a Curses window LIBRARY Curses Library (libcurses.a, libcurses.so) SYNOPSIS #include <curses.h> int inchstr(chtype *chstr); int inchnstr(chtype *chstr, int n); int winchstr(WINDOW *win, chtype *chstr); int winchnstr(WINDOW *win, chtype *chstr, int n); int mvinchstr(int y, int x, chtype *chstr); int mvinchnstr(int y, int x, chtype *chstr, int n); int mvwinchstr(WINDOW *win, int y, int x, chtype *chstr); int mvwinchnstr(WINDOW *win, int y, int x, chtype *chstr, int n); STANDARDS Interfaces documented on this reference page conform to industry stan- dards as follows: inchstr, inchnstr, winchstr, winchnstr, mvinchstr, mvinchnstr, mvwinch- str, mvwinchnstr: XPG4-UNIX Refer to the standards(5) reference page for more information about in- dustry standards and associated tags. DESCRIPTION These routines return a string of type chtype, starting at the current or specified cursor position in the current or specified window and ending at the right margin of the window. The four functions with n as the last argument, return a string that is at most n characters long. Constants defined in curses.h can be used with the & (logical AND) op- erator to extract the character or the attribute alone from any posi- tion in the chstr (see curs_inch(3)). NOTES The header file curses.h automatically includes the header file stdio.h. Note that all routines except winchnstr may be macros. RETURN VALUES All routines return the integer ERR upon failure and OK upon successful completion. RELATED INFORMATION Functions: curses(3), curs_inch(3) Others: standards(5) delim off curs_inchstr(3)