curs_getwstr(3)curs_getwstr(3)NAME
curs_getwstr, getwstr, getnwstr, wgetwstr, wgetnwstr, mvgetwstr, mvget‐
nwstr, mvwgetwstr, mvwgetnwstr - Get wchar_t character strings from a
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 );
LIBRARY
Curses Library (libcurses)
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 wstr.
The getnwstr routine reads at most n wchar_t characters, thus prevent‐
ing a possible overflow of the input buffer. The user's erase and kill
characters are interpreted, as well as any special keys (such as func‐
tion keys, “home” key, “clear” key, and so on).
NOTES
The header file <curses.h> automatically includes the header file
<stdio.h>.
Note that all routines except wgetnwstr may be macros.
The routines described on this reference page are among the MNLS Curses
functions that are not included in the X/Open Curses CAE specification.
MNLS routines are supported only for backward compatibility reasons.
Use the *get_wstr functions in new applications (see curs_get_wstr(3)).
RETURN VALUES
All routines return the integer ERR upon failure and an integer value
other than ERR upon successful completion.
SEE ALSO
Functions: curses(3), curs_getwch(3), curs_get_wstr(3)curs_getwstr(3)