cursinwchstr(3X) cursinwchstr(3X)

NAME
       iinnwwcchhssttrr, iinnwwcchhnnssttrr, wwiinnwwcchhssttrr, wwiinnwwcchhnnssttrr, mmvviinnwwcchhssttrr,
       mmvviinnwwcchhnnssttrr, mmvvwwiinnwwcchhssttrr, mmvvwwiinnwwcchhnnssttrr - get an array of complex
       characters and renditions from a curses window

SYNOPSIS
       ##iinncclluuddee <>

       iinntt iinnwwcchhssttrr((cccchhaarrtt **wchstr));;
       iinntt iinnwwcchhnnssttrr((cccchhaarrtt **wchstr,, iinntt n));;
       iinntt wwiinnwwcchhssttrr((WWIINNDDOOWW **win,, cccchhaarrtt **wchstr));;
       iinntt wwiinnwwcchhnnssttrr((WWIINNDDOOWW **win,, cccchhaarrtt **wchstr,, iinntt n));;
       iinntt mmvviinnwwcchhssttrr((iinntt y,, iinntt x,, cccchhaarrtt **wchstr));;
       iinntt mmvviinnwwcchhnnssttrr((iinntt y,, iinntt x,, cccchhaarrtt **wchstr,, iinntt n));;
       iinntt mmvvwwiinnwwcchhssttrr((WWIINNDDOOWW **win,, iinntt y,, iinntt x,, cccchhaarrtt **wchstr));;
       iinntt mmvvwwiinnwwcchhnnssttrr((WWIINNDDOOWW **win,, iinntt y,, iinntt x,, cccchhaarrtt **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  iinnwwcchhnnssttrr,  mmvviinnwwcchhnnssttrr,  mmvvwwiinnwwcchhnnssttrr and wwiinnwwcchhnnssttrr fill the
       array with at most n cccchhaarrtt elements.

NNOOTTEESS
       Note that all routines except wwiinnwwcchhnnssttrr may be macros.

       Reading a line that overflows the  array  pointed  to  by  wchstr  with
       iinnwwcchhssttrr, mmvviinnwwcchhssttrr, mmvvwwiinnwwcchhssttrr or wwiinnwwcchhssttrr causes undefined re-
       sults. Therefore, the use of iinnwwcchhnnssttrr,  mmvviinnwwcchhnnssttrr,  mmvvwwiinnwwcchhnnssttrr,
       or wwiinnwwcchhnnssttrr is recommended.

RETURN VALUES
       Upon successful completion, these functions return OOKK.  Otherwise, they
       return EERRRR.

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

SEE ALSO
       Functions: ccuurrsseess(3X), ccuurrssiinnwwcchh(3X), ccuurrssiinnssttrr(3X), ccuurrssiinnwwssttrr(3X)



                                                            cursinwchstr(3X)