


curs_instr(3X)                                     curs_instr(3X)


NNAAMMEE
       ccuurrss__iinnssttrr:   iinnssttrr,  iinnnnssttrr,  wwiinnssttrr,  wwiinnnnssttrr,  mmvviinnssttrr,
       mmvviinnnnssttrr, mmvvwwiinnssttrr, mmvvwwiinnnnssttrr - get a string of characters
       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nssttrr((cchhaarr **ssttrr));;
       iinntt iinnnnssttrr((cchhaarr **ssttrr,, iinntt nn));;
       iinntt wwiinnssttrr((WWIINNDDOOWW **wwiinn,, cchhaarr **ssttrr));;
       iinntt wwiinnnnssttrr((WWIINNDDOOWW **wwiinn,, cchhaarr **ssttrr,, iinntt nn));;
       iinntt mmvviinnssttrr((iinntt yy,, iinntt xx,, cchhaarr **ssttrr));;
       iinntt mmvviinnnnssttrr((iinntt yy,, iinntt xx,, cchhaarr **ssttrr,, iinntt nn));;
       iinntt mmvvwwiin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haarr **ssttrr));;
       iinntt  mmvvwwiinnn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haarr **s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  string  of  characters  in  _s_t_r,
       extracted  starting  at the current cursor position in the
       named window and ending at the right margin of the window.
       Attributes  are  stripped  from  the characters.  The four
       functions with _n as the last  argument  return  a  leading
       substring  at  most  _n  characters  long (exclusive of the
       trailing NUL).

RREETTUURRNN VVAALLUUEE
       All routines that return an integer return EERRRR upon  fail-
       ure  and  OK  (SVr4 specifies only "an integer value other
       than EERRRR") upon successful  completion,  unless  otherwise
       noted in the preceding routine descriptions.

NNOOTTEESS
       Note that all routines except wwiinnnnssttrr may be macros.  SVr4
       does not document  whether  a  length  limit  includes  or
       excludes the trailing NUL, and does not document the mean-
       ing of the return values.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses  standard,
       Issue  4.   The standard specifies that they always return
       OOKK on success.  The XSI Curses error conditions EEIILLSSEEQQ and
       EEIILLOOVVEERRFFLLOOWW associated with extebded-level conformance are
       not yet detected (this implementation does not yet support
       XPG4 multibyte characters).

SSEEEE AALLSSOO
       ccuurrsseess(3X).








                                                                1


