curs_get_wstr(3x) Library calls curs_get_wstr(3x)
@@ -125,20 +125,19 @@
o if the associated call to wget_wch failed.
- Functions with a "mv" prefix first perform a cursor movement using
- wmove, and return an error if the position is outside the window, or if
- the window pointer is null.
+ Functions prefixed with "mv" first perform cursor movement and fail if
+ the position (y, x) is outside the window boundaries.
Any of these functions other than wgetn_wstr may be macros.
- 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,
+ 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 because there is no way to
+ These functions cannot return KEY_ values because there is no way to
distinguish a KEY_ value from a valid wchar_t value.
@@ -146,48 +145,51 @@
These functions are described in The Single Unix Specification, 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,
+ 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.
X/Open curses documented these functions to pass an array of wchar_t in
1997, but that was an error because of this part of the description:
The effect of get_wstr is as though a series of calls to get_wch
- were made, until a newline character, end-of-line character, or
+ were made, until a newline character, end-of-line character, or
end-of-file character is processed.
- The latter function get_wch can return a negative value, while wchar_t
- is a unsigned type. All of the vendors implement this using wint_t,
+ The latter function get_wch can return a negative value, while wchar_t
+ is a unsigned type. All of the vendors implement this using wint_t,
following the standard.
X/Open Curses, Issue 7 (2009) is unclear regarding whether the
- terminating nullwchar_t value is counted in the length parameter n.
+ terminating nullwchar_t value is counted in the length parameter n.
X/Open Curses, Issue 7 revised the corresponding description of
- wgetnstr to address this issue. The unrevised description of
- wget_nwstr can be interpreted either way. This implementation counts
+ wgetnstr to address this issue. The unrevised description of
+ wget_nwstr can be interpreted either way. This implementation counts
the terminator in the length.
- X/Open Curses does not specify what happens if the length n is
+ X/Open Curses does not specify what happens if the length n is
negative.
- o For analogy with wgetnstr, ncurses 6.2 uses a limit (based on
+ o For analogy with wgetnstr, ncurses 6.2 uses a limit (based on
LINE_MAX).
- o Some other implementations (such as Solaris xcurses) do the same,
+ o Some other implementations (such as Solaris xcurses) do the same,
while others (PDCurses) do not allow this.
- o NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a -1
+ o NetBSD 7 curses imitates ncurses 6.1 in this regard, treating a -1
as an indefinite number of characters.