X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=d3d709cd9d21342c5a0a2c7244e9244fee1c0264;hp=b3b066d519f0cf51dc9bcd7048d15f99592906dc;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index b3b066d5..d3d709cd 100644 --- a/doc/html/man/curs_get_wstr.3x.html +++ b/doc/html/man/curs_get_wstr.3x.html @@ -1,7 +1,7 @@ - + @@ -40,11 +40,15 @@ 
 
+curs_get_wstr(3x)                                     curs_get_wstr(3x)
+
+
+

NAME

-       get_wstr,  getn_wstr,  wget_wstr,  wgetn_wstr, mvget_wstr,
-       mvgetn_wstr, mvwget_wstr, mvwgetn_wstr - get an  array  of
+       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
 
 
@@ -70,8 +74,8 @@
        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
@@ -114,10 +118,21 @@
-

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
@@ -126,42 +141,21 @@
        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
+       wint_t.
 
 
 

 
SEE ALSO
-       Functions:  curses(3x), curs_get_wch(3x), curs_getstr(3x).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+       Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x).
 
 
 
+                                                      curs_get_wstr(3x)