Content-type: text/html
curs_get_wstr, get_wstr, getn_wstr, wget_wstr, wgetn_wstr, mvget_wstr, mvgetn_wstr, mvwget_wstr, mvwgetn_wstr - Get an array of wide characters from a Curses terminal keyboard
#include <curses.h>
int get_wstr(
wint_t *wstr
);
int getn_wstr(
wint_t *wstr,
int n
);
int wget_wstr(
WINDOW *win,
wint_t *wstr
);
int wgetn_wstr(
WINDOW *win,
wint_t *wstr,
int n
);
int mvget_wstr(
int y,
int x,
wint_t *wstr
);
int mvgetn_wstr(
int y,
int x,
wint_t *wstr,
int n
);
int mvwget_wstr(
WINDOW *win,
int y,
int x,
wint_t *wstr
);
int mvwgetn_wstr(
WINDOW *win,
int y,
int x,
wint_t *wstr,
int n
);
Interfaces documented on this reference page conform to industry standards as follows:
get_wstr, getn_wstr, wget_wstr, wgetn_wstr, mvget_wstr, mvgetn_wstr, mvwget_wstr, mvwgetn_wstr: XPG4-UNIX
Refer to the
standards(5)
reference page for more information
about industry standards and associated tags.
The effect of get_wstr is as though a series of calls to get_wch were made, until a newline, end-of-line, or end-of-file character is processed. An end-of-file character is represented by WEOF, as defined in <wchar.h>. A newline or end-of-line character is represented as its wchar_t value. In all instances, the end of the string is terminated by a null wchar_t. The routine places resulting values in the area pointed to by wstr. The routine's interpretation of the user's erase and kill characters affects the sequence of characters returned.
The effect of wget_wstr is as though a series of calls to wget_wch were made.
The effect of mvget_wstr is as though a call to move and then a series of calls to get_wch were made.
The effect of mvwget_wstr is as though a call to wmove and then a series of calls to wget_wch were made.
The
getn_wstr,
mvgetn_wstr,
mvwgetn_wstr, and
wgetn_wstr
functions are identical
to the
get_wstr,
mvget_wstr,
mvwget_wstr, and
wget_wstr
functions, respectively,
except that the
*n_*
versions read at most
n
characters, letting the application prevent overflow of the
input buffer.
Using get_wstr, mvget_wstr, mvwget_wstr, or wget_wstr to read a line that overflows the array pointed to by wstr causes undefined results. The use of getn_wstr, mvgetn_wstr, mvwgetn_wstr, or wgetn_wstr, respectively, is recommended.
These functions cannot return KEY_ values as there is no way to distinguish a KEY_ value from a valid wchar_t value.
The header file <curses.h> automatically includes the header file <stdio.h>.
Note that all routines except
wgetn_wstr
may be macros.
All these functions return
OK
upon successful
completion. Otherwise, they return
ERR.
Functions: curses(3), curs_get_wch(3), curs_getstr(3)
Others: standards(5)