X/Open Curses Library Functions                 getnstr(3XCURSES)



NAME
     getnstr, getstr, mvgetnstr, mvgetstr, mvwgetnstr, mvwgetstr,
     wgetnstr,  wgetstr  -  get a multibyte character string from
     terminal

SYNOPSIS
     cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
      -R  /usr/xpg4/lib  -lcurses  [ library... ]

     c89 [ flag... ] file... -lcurses [ library... ]

     #include 

     int getnstr(char *str, int n);


     int getstr(char *str);


     int mvgetnstr(int y, int x, char *str, int n);


     int mvgetstr(int y, int x, char *str);


     int mvwgetnstr(WINDOW *win, int y, int x, char *str, int n);


     int mvwgetstr(WINDOW *win, int y, int x, char *str);


     int wgetnstr(WINDOW *win, char *str, int n);


     int wgetstr(WINDOW *win, char *str);


DESCRIPTION
     The getstr() and wgetstr() functions get a character  string
     from  the terminal associated with the window stdscr or win-
     dow  win, respectively. The mvgetstr() and mvwgetstr() func-
     tions  move  the cursor to the  position specified in stdscr
     or win, respectively, then get a  character string.


     These  functions  call  wgetch(3XCURSES)  and   place   each
     received character in str until a newline is received, which
     is also placed in str. The erase and kill characters set  by
     the user are processed.






SunOS 5.11           Last change: 5 Jun 2002                    1






X/Open Curses Library Functions                 getnstr(3XCURSES)



     The getnstr(),  mvgetnstr(),  mvwgetnstr()  and   wgetnstr()
     functions  read  at  most n characters.  These functions are
     used to prevent overflowing the input buffer.


     The getnstr(),  wgetnstr(),  mvgetnstr(),  and  mvwgetnstr()
     functions  only return complete multibyte characters. If the
     area pointed to by str is not large enough to hold at  least
     one character, these functions fail.

PARAMETERS
     str    Is a pointer to the area where the  character  string
            is to be placed.


     n      Is the maximum number  of  characters  to  read  from
            input.


     y      Is the y (row) coordinate  of  starting  position  of
            character string to be read.


     x      Is the x (column) coordinate of starting position  of
            character string to be read.


     win    Points to the window  associated  with  the  terminal
            from which the character  is to be read.


RETURN VALUES
     On success,  these  functions  return  OK.  Otherwise,  they
     return ER.

ERORS
     None.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:














SunOS 5.11           Last change: 5 Jun 2002                    2






X/Open Curses Library Functions                 getnstr(3XCURSES)



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     Unsafe                      
    


SEE ALSO
     getch(3XCURSES), libcurses(3XCURSES),  attributes(5),  stan-
     dards(5)











































SunOS 5.11           Last change: 5 Jun 2002                    3