


curs_getstr(3X)                                   curs_getstr(3X)


NNAAMMEE
       ccuurrss__ggeettssttrr:   ggeettssttrr,   wwggeettssttrr,   mmvvggeettssttrr,   mmvvwwggeettssttrr,
       wwggeettnnssttrr - accept character strings from  ccuurrsseess  terminal
       keyboard

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 ggeettssttrr((cchhaarr **ssttrr));;
       iinntt wwggeetts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 mmvvggeetts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vwwggeetts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 wwggeettn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));;

DDEESSCCRRIIPPTTIIOONN
       The  function ggeettssttrr is equivalent to a series of calls to
       ggeettcchh, until a newline or carriage return is received (the
       terminating  character  is  not  included  in the returned
       string).  The  resulting  value  is  placed  in  the  area
       pointed to by the character pointer _s_t_r.

       wwggeettnnssttrr  reads  at  most  _n characters, thus preventing a
       possible overflow of the input  buffer.   Any  attempt  to
       enter  more characters (other than the terminating newline
       or carriage return) causes a  beep.   Function  keys  also
       cause a beep and are ignored.

       The  user's erase and kill characters are interpreted.  If
       keypad  mode  is  on  for   the   window,   KKEEYY__LLEEFFTT   and
       KKEEYY__BBAACCKKSSPPAACCEE are both considered equivalent to the user's
       kill character.

       Characters input are echoed only if eecchhoo is currently  on.
       In  that case, backspace is echoed as deletion of the pre-
       vious character (typically a left motion).

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 OOKK
       (SVr4  specifies  only  "an integer value other than EERRRR")
       upon successful completion.

NNOOTTEESS
       Note that ggeettssttrr, mmvvggeettssttrr, and mmvvwwggeettssttrr may be macros.

PPOORRTTAABBIILLIITTYY
       These functions are described in the XSI Curses  standard,
       Issue  4.   They  read  single-byte  characters only.  The
       standard specifies that they return EERRRR  on  failure,  but
       the  single  error  condition  EEOOVVEERRFFLLOOWW  associated  with
       extended-level conformance is not yet  returned  (the  XSI
       curses  support  for multi-byte characters is not yet pre-
       sent).

       SVr3 and early SVr4 curses implementations did not  reject



                                                                1





curs_getstr(3X)                                   curs_getstr(3X)


       function keys; the SVr4.0 documentation claimed that "spe-
       cial keys" (such as function  keys,  "home"  key,  "clear"
       key,  _e_t_c.)  are  interpreted" without giving details.  It
       lied.  In fact, the  `character'  value  appended  to  the
       string  by  those  implementations was predictable but not
       useful (being, in fact, the low-order eight  bits  of  the
       key's KEY_ value).

       The functions ggeettnnssttrr, mmvvggeettnnssttrr, and mmvvwwggeettnnssttrr were pre-
       sent but not documented in SVr4.

SSEEEE AALLSSOO
       ccuurrsseess(3X), ccuurrss__ggeettcchh(3X).












































                                                                2


