X/Open Curses Library Functions              inwchnstr(3XCURSES)



NAME
     inwchnstr,    inwchstr,     mvinwchnstr,     mvinwchstr,
     mvwinwchnstr,   mvwinwchstr,   winwchnstr,  winwchstr  -
     retrieve complex character string (with rendition)

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 inwchnstr(cchart *wchstr, int n);


     int inwchstr(cchart *wchstr);


     int mvinwchnstr(int y, int x, cchart *wchstr, int n);


     int mvinwchstr(int y, int x, cchart *wchstr);


     int mvwinwchnstr(WINDOW *win, int y, int x, cchart *wchstr, int n);


     int mvwinwchstr(WINDOW *win, int y, int x, cchart *wchstr);


     int winwchnstr(WINDOW *win, cchart *wchstr, int n);


     int winwchstr(WINDOW *win, cchart *wchstr);


DESCRIPTION
     The inwchstr() and winwchstr() functions retrieve  a  com-
     plex   character  string  (with  rendition)  starting at the
     current cursor position of  the  stdscr  window  and  window
     win,  respectively,  and  ending  at   the right margin. The
     mvinwchstr() and mvwinwchstr() functions retrieve  a  com-
     plex  character  string located at the position indicated by
     the x  (column) and y (row) parameters (the  former  in  the
     stdscr window; the latter in window win).


     The   inwchnstr(),   winwchnstr(),   mvinwchnstr(),   and
     mvwinwchnstr() functions retrieve at most n characters from
     the  window stdscr and win,  respectively.  The  former  two
     functions  retrieve  the  string,  starting  at  the current



SunOS 5.11           Last change: 5 Jun 2002                    1






X/Open Curses Library Functions              inwchnstr(3XCURSES)



     cursor  position;  the  latter  two  commands  retrieve  the
     string,  starting  at the position  specified by the x and y
     parameters.


     The retrieved character string (with renditions)  is  stored
     in the object pointed to by wcval.

PARAMETERS
     wchstr    Is a pointer to an object where the retrieved com-
               plex character string can be stored.


     n         Is the number of characters  not  to  exceed  when
               retrieving wchstr.


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


     x         Is the x (column) coordinate of the starting posi-
               tion of the string to be  retrieved.


     win       Is a pointer to the window in which the string  is
               to be retrieved.


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              inwchnstr(3XCURSES)



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     Unsafe                      
    


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











































SunOS 5.11           Last change: 5 Jun 2002                    3