X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=b24f16563653aefb981fdfcc6876601f555f5917;hp=7fff4458361117d216740aad00c7d5f1dac09362;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012 diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 7fff4458..b24f1656 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,6 +1,6 @@ @@ -38,23 +38,20 @@
-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 --
+
#include <curses.h> int get_wstr(wint_t *wstr); @@ -67,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 @@ -103,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, @@ -118,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. @@ -135,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, @@ -150,8 +143,7 @@ wint_t. --
+
Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x).