curs_getwstr(3X)               27 Jan 1992                 curs_getwstr(3X)

NAME
     cursgetwstr: getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr,
     mvgetnwstr, mvwgetwstr, mvwgetnwstr - get wchart character strings
     from curses terminal keyboard

SYNOPSIS
     #include <curses.h>

     int getwstr(wchart *wstr);
     int getnwstr(wchart *wstr, int n);
     int mvgetwstr(int y, int x, wchart *wstr);
     int mvgetnwstr(int y, int x, wchart *wstr, int n);
     int mvwgetwstr(WINDOW *win, int y, int x, wchart *wstr);
     int mvwgetnwstr(WINDOW *win, int y, int x, wchart *wstr, int n);
     int wgetwstr(WINDOW *win, wchart *wstr);
     int wgetnwstr(WINDOW *win, wchart *wstr, int n);

DESCRIPTION
     The effect of getwstr is as though a series of calls to getwch were
     made, until a newline, carriage return or KEY_ENTER was received. The
     resulting value is placed in the area pointed to by the wchart
     pointer str. getnwstr reads at most n-1 wchart characters thus
     preventing a possible overflow of the input buffer, and leaving room
     for the terminating wchart null. The user's erase and kill characters
     are interpreted, as well as any special keys (such as function keys,
     "home" key, "clear" key, etc.).

     The newline, carriage return or KEY_ENTER, if any, is not stored in
     the buffer. A wchart null is placed in the buffer after the last
     character read.

RETURN VALUE
     All routines return the integer ERR upon failure and an integer value
     other than ERR upon successful completion.

NOTES
     The header file <curses.h> automatically includes the header files
     <stdio.h> and <unctrl.h>.

     Note that all routines except wgetnwstr may be macros.

SEE ALSO
     curses(3X), cursgetwch(3X).












Page 1                       Reliant UNIX 5.44                      1, 1927