


curs_inchstr(3X)                                 curs_inchstr(3X)


NNAAMMEE
       ccuurrss__iinncchhssttrr:   iinncchhssttrr,  iinncchhnnssttrr,  wwiinncchhssttrr,  wwiinncchhnnssttrr,
       mmvviinncchhssttrr, mmvviinncchhnnssttrr, mmvvwwiinncchhssttrr,  mmvvwwiinncchhnnssttrr  -  get  a
       string of characters (and attributes) from a ccuurrsseess window

SSYYNNOOPPSSIISS
       ##iinncclluuddee <<ccuurrsseess..hh>>

       iinntt iinncchhssttrr((cchhttyyppee **cchhssttrr));;
       iinntt iinncchhnnssttrr((cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt wwiinncchhssttrr((WWIINNDDOOWW **wwiinn,, cchhttyyppee **cchhssttrr));;
       iinntt wwiinncchhnnssttrr((WWIINNDDOOWW **wwiinn,, cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt mmvviinncchhssttrr((iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr));;
       iinntt mmvviinncchhnnssttrr((iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr,, iinntt nn));;
       iinntt mmvvwwiinncchhssttrr((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, cchhttyyppee **cchhssttrr));;
       iinntt mmvvwwiinncchhnnssttrr((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, cchhttyyppee  **cchhssttrr,,
       iinntt nn));;

DDEESSCCRRIIPPTTIIOONN
       These  routines  return  a NULL-terminated array of cchhttyyppee
       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  <<ccuurrsseess..hh>>
       can  be  used with the && (logical AND) operator to extract
       the character or the attribute alone from any position  in
       the _c_h_s_t_r [see curs_inch(3X)].

RREETTUURRNN VVAALLUUEE
       All  routines  return  the integer EERRRR upon failure and an
       integer value other than EERRRR  upon  successful  completion
       (the  number  of  characters  retrieved,  exclusive of the
       trailing 0).

NNOOTTEESS
       Note that all routines except  wwiinncchhnnssttrr  may  be  macros.
       SVr4 does not document whether the result string is 0-ter-
       minated; it does not document whether a length limit argu-
       ment includes any trailing 0; and it does not document the
       meaning of the return value.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses  standard,
       Issue  4.  It is no more specific than the SVr4 documenta-
       tion on the trailing 0.  It does specify that the success-
       ful return of the functions is OOKK.

SSEEEE AALLSSOO
       ccuurrsseess(3X), ccuurrss__iinncchh(3X).







                                                                1


