curs_inwchstr(3X)              27 Jan 1992                curs_inwchstr(3X)

NAME
     cursinwchstr:  inwchstr, inwchnstr, winwchstr, winwchnstr,
     mvinwchstr, mvinwchnstr, mvwinwchstr, mvwinwchnstr - get a string of
     wchart characters (and attributes) from a curses window

SYNOPSIS
     #include <curses.h>

     int inwchstr(chtype *wchstr);
     int inwchnstr(chtype *wchstr, int n);
     int winwchstr(WINDOW *win, chtype *wchstr);
     int winwchnstr(WINDOW *win, chtype *wchstr, int n);
     int mvinwchstr(int y, int x, chtype *wchstr);
     int mvinwchnstr(int y, int x, chtype *wchstr, int n);
     int mvwinwchstr(WINDOW *win, int y, int x, chtype *wchstr);
     int mvwinwchnstr(WINDOW *win, int y, int x, chtype *wchstr, int n);

DESCRIPTION
     With these routines, a string of type chtype holding wchart charac-
     ters is returned, starting at the current cursor position in the named
     window and ending at the right margin of the window. The four func-
     tions with n as the last argument return at most n wchart characters.
     The string is null terminated if less than n characters are returned.
     Constants defined in <curses.h> can be used with the & (logical AND)
     operator to extract the wchart 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 winwchnstr may be macros.

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
















Page 1                       Reliant UNIX 5.44                      1, 1927