X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=4d628a8e190d3f7154445bb95855653bb81987c6;hp=4adca85bed43f60e5765c03239fbdaf9a1f23199;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index 4adca85b..4d628a8e 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,7 +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 +NAME
+ 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-SYNOPSIS
+SYNOPSIS
#include <curses.h> int get_wstr(wint_t *wstr); @@ -67,15 +67,15 @@-DESCRIPTION
+DESCRIPTION
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 - resulting values in the area pointed to by wstr. + is terminated by a null wchar_t. The routine places re- + sulting 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,7 +103,7 @@-NOTES
+NOTES
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,20 +118,31 @@-RETURN VALUES
+RETURN VALUE
All of these functions return OK upon successful comple- tion. Otherwise, they return ERR. + 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. + + 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. +-PORTABILITY
+PORTABILITY
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 - array contains a WEOF followed by a null wchar_t. + 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 @@ -139,17 +150,23 @@-SEE ALSO
- Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x). +SEE ALSO
+ Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x). - curs_get_wstr(3x) + curs_get_wstr(3x)-
- -Man(1) output converted with -man2html - +