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=9bf39184aa37eef381f7c2dc5dacdd7a192947d3;hb=HEAD;hpb=f5aadfb8596c96e69ce2b772cd06626f2fba8ddc diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 9bf39184..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) @@ -47,9 +47,9 @@
- 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 + get_wstr, getn_wstr, wget_wstr, wgetn_wstr, mvget_wstr, mvgetn_wstr, + mvwget_wstr, mvwgetn_wstr - get a wide-character string from a curses + terminal keyboard
@@ -101,44 +101,44 @@ cursor at the beginning of the buffer. Characters input are echoed only if echo is currently on. In that - case, backspace is echoed as deletion of the previous character (typi- - cally a left motion). + case, backspace is echoed as deletion of the previous character + (typically a left motion). The getn_wstr, mvgetn_wstr, mvwgetn_wstr, and wgetn_wstr functions are - identical to the get_wstr, mvget_wstr, mvwget_wstr, and wget_wstr func- - tions, respectively, except that the *n_* versions read at most n char- - acters, letting the application prevent overflow of the input 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, respec- - tively, 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. + 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.
- All of these functions return the integer OK upon successful comple- - tion. If unsuccessful, they return ERR. + All of these functions return the integer OK upon successful + completion. If unsuccessful, they return ERR. X/Open defines no error conditions. In this implementation, these functions return an error - o if the window pointer is null, or + o if the window pointer is null, - o if its timeout expires without having any data. + o if its timeout expires without having any data, or 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.
@@ -161,40 +161,43 @@ 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 termi- - nating 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 in- - terpreted either way. This implementation counts the terminator in the - length. + X/Open Curses, Issue 7 (2009) is unclear regarding whether the + 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 + the terminator in the length. - X/Open Curses does not specify what happens if the length n is nega- - tive. + 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, 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-07-29 curs_get_wstr(3x) + +ncurses 6.5 2024-04-20 curs_get_wstr(3x)