X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=853075a8cbf6ebd0f52207f58fc31325c5ef96a5;hp=4d628a8e190d3f7154445bb95855653bb81987c6;hb=dcfe712cb3492636e8d50c9867cf05aec089a576;hpb=027d0c57c4c4d6690e8d8727888d3282dbe9aa86 diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 4d628a8e..853075a8 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,6 +1,6 @@ @@ -45,15 +45,13 @@ - -
+
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 --
+
#include <curses.h> int get_wstr(wint_t *wstr); @@ -66,16 +64,15 @@ int mvwgetn_wstr(WINDOW *win, int y, int x, wint_t *wstr, int n); --
+
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 - \n wchar_t value. In all instances, the end of the string - is terminated by a null wchar_t. The routine places re- - sulting 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 \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 @@ -102,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, @@ -117,8 +113,7 @@ All of these routines except wgetn_wstr may be macros. --
+
All of these functions return OK upon successful comple- tion. Otherwise, they return ERR. @@ -134,8 +129,7 @@ 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, @@ -144,13 +138,21 @@ 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. + 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 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. + + +
Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x).