cursinwstr(3X) cursinwstr(3X)

NAME
       iinnwwssttrr,  iinnnnwwssttrr,  wwiinnwwssttrr,  wwiinnnnwwssttrr,  mmvviinnwwssttrr, mmvviinnnnwwssttrr, mmvvwwiinnwwssttrr,
       mmvvwwiinnnnwwssttrr - get a string of wwcchhaarrtt characters from a curses window

SYNOPSIS
       ##iinncclluuddee <>

       iinntt iinnwwssttrr((wwcchhaarrtt **str));;
       iinntt iinnnnwwssttrr((wwcchhaarrtt **str,, iinntt n));;
       iinntt wwiinnwwssttrr((WWIINNDDOOWW **win,, wwcchhaarrtt **str));;
       iinntt wwiinnnnwwssttrr((WWIINNDDOOWW **win,, wwcchhaarrtt **str,, iinntt n));;
       iinntt mmvviinnwwssttrr((iinntt y,, iinntt x,, wwcchhaarrtt **str));;
       iinntt mmvviinnnnwwssttrr((iinntt y,, iinntt x,, wwcchhaarrtt **str,, iinntt n));;
       iinntt mmvvwwiinnwwssttrr((WWIINNDDOOWW **win,, iinntt y,, iinntt x,, wwcchhaarrtt **str));;
       iinntt mmvvwwiinnnnwwssttrr((WWIINNDDOOWW **win,, iinntt y,, iinntt x,, wwcchhaarrtt **str,, iinntt n));;

DESCRIPTION
       These routines return a string of wwcchhaarrtt 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.

NNOOTTEESS
       Note that all routines except wwiinnnnwwssttrr may be macros.

RETURN VALUES
       All  routines  return EERRRR upon failure. Upon successful completion, the
       *iinnwwssttrr routines return OOKK, and the *iinnnnwwssttrr routines return the number
       of characters read into the string.

SEE ALSO
       Functions: ccuurrsseess(3X), ccuurrssiinnssttrr(3X), ccuurrssiinnwwcchhssttrr(3X)



                                                               cursinwstr(3X)