X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_get_wstr.3x.html;h=e1035e021b4dcacd2a0de1cca03212a546131af9;hp=ae0fe1fe488d53f5bf06ebc12957743478fac708;hb=HEAD;hpb=d1a029866f6d84087781eaa81de19949d8533426 diff --git a/doc/html/man/curs_get_wstr.3x.html b/doc/html/man/curs_get_wstr.3x.html index ae0fe1fe..9e18e64f 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 2023-08-05 ncurses 6.4 Library calls +curs_get_wstr 3x 2024-04-20 ncurses 6.5 Library calls -

curs_get_wstr 3x 2023-08-05 ncurses 6.4 Library calls

+

curs_get_wstr 3x 2024-04-20 ncurses 6.5 Library calls

 curs_get_wstr(3x)                Library calls               curs_get_wstr(3x)
 
@@ -47,9 +47,9 @@

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
+       get_wstr,  getn_wstr,  wget_wstr,  wgetn_wstr, mvget_wstr, mvgetn_wstr,
+       mvwget_wstr, mvwgetn_wstr - get a wide-character string from  a  curses
+       terminal keyboard

SYNOPSIS

@@ -101,30 +101,19 @@
            cursor at the beginning of the buffer.
 
        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).
+       case,  backspace  is  echoed  as  deletion  of  the  previous character
+       (typically a left motion).
 
        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.
-
-
-

NOTES

-       Any of these functions other than wgetn_wstr may be macros.
-
-       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.  may be macros.
+       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.

RETURN VALUE

-       All  of  these  functions return the integer OK upon successful comple-
-       tion.  If unsuccessful, they return ERR.
+       All  of  these  functions  return  the  integer  OK   upon   successful
+       completion.  If unsuccessful, they return ERR.
 
        X/Open defines no error conditions.
 
@@ -136,9 +125,20 @@
 
        o   if the associated call to wget_wch failed.
 
-       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.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       Any of these functions other than wgetn_wstr may be macros.
+
+       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.
+
+       These  functions  cannot  return KEY_ values because there is no way to
+       distinguish a KEY_ value from a valid wchar_t value.

PORTABILITY

@@ -161,40 +161,43 @@
        is a unsigned type.  All of the vendors implement  this  using  wint_t,
        following the standard.
 
-       X/Open  Curses,  Issue 7 (2009) is unclear regarding whether the termi-
-       nating null wchar_t value is counted in the length parameter n.  X/Open
-       Curses,  Issue  7  revised the corresponding description of wgetnstr to
-       address this issue.  The unrevised description of wget_nwstr can be in-
-       terpreted either way.  This implementation counts the terminator in the
-       length.
+       X/Open  Curses,  Issue  7  (2009)  is  unclear  regarding  whether  the
+       terminating null wchar_t value is counted in the  length  parameter  n.
+       X/Open  Curses,  Issue  7  revised  the  corresponding  description  of
+       wgetnstr  to  address  this  issue.   The  unrevised   description   of
+       wget_nwstr  can  be interpreted either way.  This implementation counts
+       the terminator in the length.
 
-       X/Open Curses does not specify what happens if the length  n  is  nega-
-       tive.
+       X/Open Curses does  not  specify  what  happens  if  the  length  n  is
+       negative.
 
-       o   For  analogy  with  wgetnstr,  ncurses  6.2  uses a limit (based on
+       o   For  analogy  with  wgetnstr,  ncurses  6.2  uses a limit (based on
            LINE_MAX).
 
        o   Some other implementations (such as Solaris xcurses) do  the  same,
            while others (PDCurses) do not allow this.
 
-       o   NetBSD  7 curses imitates ncurses 6.1 in this regard, treating a -1
+       o   NetBSD  7 curses imitates ncurses 6.1 in this regard, treating a -1
            as an indefinite number of characters.

SEE ALSO

-       Functions: curses(3x), curs_get_wch(3x), curs_getstr(3x).
+       curs_getstr(3x) describes comparable functions of the  ncurses  library
+       in its non-wide-character configuration.
 
+       curses(3x), curs_get_wch(3x)
 
 
-ncurses 6.4                       2023-08-05                 curs_get_wstr(3x)
+
+ncurses 6.5                       2024-04-20                 curs_get_wstr(3x)