X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=e1035e021b4dcacd2a0de1cca03212a546131af9;hp=fcecf4cb7e98cd64f811d523b7ca991fbd33245e;hb=HEAD;hpb=31c4bcf3307145fc5368b4aaf15e41bdd66a984b diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index fcecf4cb..9e18e64f 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,6 +1,6 @@
-curs_get_wstr(3x) Library calls curs_get_wstr(3x) @@ -111,18 +111,6 @@ buffer. -
- 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, - respectively, is recommended. - - These functions cannot return KEY_ values because there is no way to - distinguish a KEY_ value from a valid wchar_t value. may be macros. - -
All of these functions return the integer OK upon successful completion. If unsuccessful, they return ERR. @@ -137,65 +125,79 @@ 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, + respectively, is recommended. + + These functions cannot return KEY_ values because there is no way to + distinguish a KEY_ value from a valid wchar_t value.
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 null wchar_t value is counted in the length parameter n. + terminating null wchar_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.
- Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x). + curs_getstr(3x) describes comparable functions of the ncurses library + in its non-wide-character configuration. + curses(3x), curs_get_wch(3x) -ncurses 6.4 2023-09-16 curs_get_wstr(3x) + +ncurses 6.5 2024-04-20 curs_get_wstr(3x)