X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=dc1a413c84eec993d35534c90ec0fe6e83d562b9;hp=853075a8cbf6ebd0f52207f58fc31325c5ef96a5;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=dcfe712cb3492636e8d50c9867cf05aec089a576;ds=sidebyside diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 853075a8..dc1a413c 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) curs_get_wstr(3x) +curs_get_wstr(3x) curs_get_wstr(3x)
- 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 an array of wide characters from a + curses terminal keyboard
@@ -65,91 +65,81 @@
- The effect of get_wstr is as though a series of calls to - 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 \n 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 effect of get_wstr is as though a series of calls to 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 de- + fined in <wchar.h>. The newline and end-of-line conditions are repre- + sented by the \n 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 user's erase and kill characters are interpreted. If - keypad mode is on for the window, KEY_LEFT and - KEY_BACKSPACE are both considered equivalent to the user's - kill character. + The user's erase and kill characters are interpreted. If keypad mode + is on for the window, KEY_LEFT and KEY_BACKSPACE are both considered + equivalent to the user's kill character. - Characters input are echoed only if echo is currently on. - In that case, backspace is echoed as deletion of the pre- - vious character (typically a left motion). + 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). - The effect of wget_wstr is as though a series of calls to - wget_wch were made. + 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 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 effect of mvwget_wstr is as though a call to wmove and then a se- + ries 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. + 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.
- 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. + 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. + These functions cannot return KEY_ values because there is no way to + distinguish a KEY_ value from a valid wchar_t value. All of these routines except wgetn_wstr may be macros.
- All of these functions return OK upon successful comple- - tion. Otherwise, they return ERR. + All of these functions return OK upon successful completion. Other- + wise, they return ERR. - Functions using a window parameter return an error if it - is null. + Functions using a window parameter return an error if it is null. wgetn_wstr - returns an error if the associated call to - wget_wch failed. + 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. + 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.
- 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 ar- - ray contains a WEOF followed by a null wchar_t. + 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 re- + turns 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: + 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 char- - acter, end-of-line character, or end-of-file char- - acter is processed. + 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 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 im- - plement this using wint_t, following the standard. + 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.
@@ -157,7 +147,7 @@ - curs_get_wstr(3x) + curs_get_wstr(3x)