+ 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
-
The effect of get_wstr is as though a series of calls to
- get_wch were made, until a newline, other end-of-line, or
- end-of-file condition is processed. An end-of-file condi-
- tion is represented by WEOF, as defined in <wchar.h>. The
- newline and end-of-line conditions are represented by the
- \nwchar_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.
+ get_wch(3x) were made, until a newline, other end-of-line,
+ or end-of-file condition is processed. An end-of-file
+ condition is represented by WEOF, as defined in <wchar.h>.
+ The newline and end-of-line conditions are represented by
+ the \nwchar_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 user's erase and kill characters are interpreted. If
keypad mode is on for the window, KEY_LEFT and
@@ -98,8 +99,7 @@
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,
@@ -113,60 +113,53 @@
All of these routines except wgetn_wstr may be macros.
-
All of these functions return OK upon successful comple-
tion. Otherwise, they return ERR.
+ Functions using a window parameter return an error if it
+ is null.
-
-
PORTABILITY
+ wgetn_wstr
+ returns an error if the associated call to
+ wget_wch failed.
+
+ Functions with a "mv" prefix first perform a cursor move-
+ ment using wmove, and return an error if the position is
+ outside the window, or if the window pointer is null.
+
+
+
These functions are described in The Single Unix Specifi-
cation, Version 2. No error conditions are defined. This
implementation returns ERR if the window pointer is null,
or if the lower-level wget_wch call returns an ERR. In
the latter case, an ERR return without other data is
- treated as an end-of-file condition, and the returned
- array contains a WEOF followed by a null wchar_t.
-
-
-
-
SEE ALSO
- Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ treated as an end-of-file condition, and the returned ar-
+ ray contains a WEOF followed by a null wchar_t.
+ X/Open curses documents these functions to pass an array
+ of wchar_t, but all of the vendors implement this using
+ wint_t.
+