cursinchstr(3X) cursinchstr(3X)

NAME
       iinncchhssttrr, iinncchhnnssttrr, wwiinncchhssttrr, wwiinncchhnnssttrr, mmvviinncchhssttrr, mmvviinncchhnnssttrr,
       mmvvwwiinncchhssttrr, mmvvwwiinncchhnnssttrr - get a string of characters (and attributes)
       from a ccuurrsseess window

SYNOPSIS
       ##iinncclluuddee <>

       iinntt iinncchhssttrr((cchhttyyppee **cchhssttrr));;
       iinntt iinncchhnnssttrr((cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt wwiinncchhssttrr((WWIINNDDOOWW **wwiinn,, cchhttyyppee **cchhssttrr));;
       iinntt wwiinncchhnnssttrr((WWIINNDDOOWW **wwiinn,, cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt mmvviinncchhssttrr((iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr));;
       iinntt mmvviinncchhnnssttrr((iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt mmvvwwiinncchhssttrr((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr));;
       iinntt mmvvwwiinncchhnnssttrr((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr,, iinntt nn));;

DESCRIPTION
       These  routines  return  a  NULL-terminated array of cchhttyyppee quantities,
       starting at the current cursor position in the named window and  ending
       at  the  right  margin of the window.  The four functions with n as the
       last argument, return a leading substring at  most  n  characters  long
       (exclusive of the trailing (chtype)0).  Constants defined in <>
       can be used with the && (logical AND) operator to extract the  character
       or   the   attribute   alone  from  any  position  in  the  chstr  [see
       ccuurrssiinncchh(3X)].

RREETTUURRNN VVAALLUUEE
       All routines return the integer EERRRR upon failure and an  integer  value
       other than EERRRR upon successful completion (the number of characters re-
       trieved, exclusive of the trailing 0).

       No error conditions are defined.  If the chstr parameter  is  null,  no
       data is returned, and the return value is zero.

NNOOTTEESS
       Note  that  all routines except wwiinncchhnnssttrr may be macros.  SVr4 does not
       document whether the result string is 0-terminated; it does  not  docu-
       ment  whether  a  length limit argument includes any trailing 0; and it
       does not document the meaning of the return value.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses standard, Issue 4.   It
       is  no more specific than the SVr4 documentation on the trailing 0.  It
       does specify that the successful return of the functions is OOKK.

SEE ALSO
       ccuurrsseess(3X), ccuurrssiinncchh(3X).



                                                              cursinchstr(3X)