X/Open Curses Library Functions               getnwstr(3XCURSES)



NAME
     getnwstr, getwstr, mvgetnwstr, mvgetwstr,  mvwgetnwstr,
     mvwgetwstr,  wgetnwstr,  wgetwstr  - get a wide 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 getnwstr(wintt *wstr, int n);


     int getwstr(wintt *wstr);


     int mvgetnwstr(int y, int x, wintt *wstr, int n);


     int mvgetwstr(int y, int x, wintt *wstr);


     int mvwgetnwstr(WINDOW *win, int y, int x, wintt *wstr, int n);


     int mvwgetwstr(WINDOW *win, int y, int x, wintt *wstr);


     int wgetnwstr(WINDOW *win, wintt *wstr, int n);


     int wgetwstr(WINDOW *win, wintt *wstr);


DESCRIPTION
     The getwstr() and wgetwstr() functions get a wide  charac-
     ter  string  from  the  terminal  associated with the window
     stdscr or window  win,  respectively.  The  mvgetstr()  and
     mvwgetwstr()  functions  move  the  cursor to  the position
     specified in stdscr or win, respectively, then get  a   wide
     character string.


     These  functions  call  wgetwch(3XCURSES)  and  place  each
     received  character  in wstr until a newline character, end-
     of-line character, or  end-of-file  character  is  received,
     which  is also placed in wstr. 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               getnwstr(3XCURSES)



     The   getnwstr(),   mvgetnwstr(),    mvwgetnwstr()    and
     wgetnwstr()  functions  read  at  most n characters.  These
     functions are used to prevent overflowing the input buffer.

PARAMETERS
     wstr    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:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     Unsafe                      
    


SEE ALSO
     getwch(3XCURSES),  getnstr(3XCURSES),  libcurses(3XCURSES),
     attributes(5), standards(5)





SunOS 5.11           Last change: 5 Jun 2002                    2