curs_inchstr(3X)               DG/UX 5.4R3.00               curs_inchstr(3X)


NAME
       cursinchstr:  inchstr, inchnstr, winchstr, winchnstr, mvinchstr,
       mvinchnstr, mvwinchstr, mvwinchnstr - get a string of characters (and
       attributes) from a curses window

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);

DESCRIPTION
       With these routines, a string of type chtype, starting at the current
       cursor position in the named window and ending at the right margin of
       the window, is returned.  The four functions with n as the last
       argument, return the string at most n characters long.  Constants
       defined in <curses.h> can be used with the & (logical AND) operator
       to extract the character or the attribute alone from any position in
       the chstr [see curs_inch(3X)].

RETURN VALUE
       All routines return the integer ERR upon failure and an integer value
       other than ERR upon successful completion.

NOTES
       The header file <curses.h> automatically includes the header files
       <stdio.h> and <unctrl.h>.

       Note that all routines except winchnstr may be macros.

SEE ALSO
       curses(3X), cursinch(3X).



















Licensed material--property of copyright holder(s)                         1