cursinwchstr(3X)                                          cursinwchstr(3X)



NAME
       inwchstr, inwchnstr, winwchstr, winwchnstr, mvinwchstr, mvinwchn-
       str, mvwinwchstr, mvwinwchnstr - get an array of  complex  characters
       and renditions from a curses window

SYNOPSIS
       ##include <>

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

DESCRIPTION
       These functions return an array of complex characters in wchstr, start-
       ing at the current cursor position in  the  named  window.   Attributes
       (rendition) are stored with the characters.

       The  inwchnstr,  mvinwchnstr,  mvwinwchnstr and winwchnstr fill the
       array with at most n cchart elements.

NOTES
       Note that all routines except winwchnstr may be macros.

       Reading a line that overflows the  array  pointed  to  by  wchstr  with
       inwchstr,  mvinwchstr,  mvwinwchstr  or  winwchstr causes undefined
       results. Therefore, the use of inwchnstr, mvinwchnstr, mvwinwchnstr,
       or winwchnstr is recommended.

RETURN VALUES
       Upon successful completion, these functions return OK.  Otherwise, they
       return ER.

PORTABILITY
       The XSI Curses defines no error conditions.  This implementation checks
       for null pointers, returning ER in that case.

SEE ALSO
       Functions: curses(3X), cursinwch(3X) cursinstr(3X), cursinwstr(3X)



                                                            cursinwchstr(3X)