curs_getwstr(3X)

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

SYNOPSIS
     #include <curses.h>

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

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

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), curs_getwch(3X).