cursinwstr(3)                                                  cursinwstr(3)



NAME
       inwstr,  innwstr,  winwstr,  winnwstr,  mvinwstr, mvinnwstr, mvwinwstr,
       mvwinnwstr - get a string of wchart characters from a curses window

SYNOPSIS
       ##include <>

       int inwstr(wchart **str);;
       int innwstr(wchart **str,, int n);;
       int winwstr(WINDOW **win,, wchart **str);;
       int winnwstr(WINDOW **win,, wchart **str,, int n);;
       int mvinwstr(int y,, int x,, wchart **str);;
       int mvinnwstr(int y,, int x,, wchart **str,, int n);;
       int mvwinwstr(WINDOW **win,, int y,, int x,, wchart **str);;
       int mvwinnwstr(WINDOW **win,, int y,, int x,, wchart **str,, int n);;

DESCRIPTION
       These routines return a string of wchart characters in wstr, extracted
       starting   at   the  current  cursor  position  in  the  named  window.
       Attributes are stripped from the characters.  The four functions with n
       as  the  last  argument return a leading substring at most n bytes long
       (exclusive of the trailing NUL).  Transfer stops at the end of the cur-
       rent  line, or when n bytes have been stored at the location referenced
       by wstr.

       If the size n is not large enough to store  a  complete  character,  an
       error is generated.

NOTES
       Note that all routines except winnwstr may be macros.

RETURN VALUES
       All  routines  return ER upon failure. Upon successful completion, the
       *inwstr routines return OK, and the *innwstr routines return the number
       of characters read into the string.

SEE ALSO
       Functions: curses(3X), cursinstr(3X), cursinwchstr(3X)



                                                                cursinwstr(3)