X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_inwstr.3x.html;h=0d8c3c1e71dbcddafea11f0909c9a5f35b924355;hp=f70cc7874da47d9453b745de35d9820a933f47e1;hb=HEAD;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280 diff --git a/doc/html/man/curs_inwstr.3x.html b/doc/html/man/curs_inwstr.3x.html index f70cc787..ddd51afb 100644 --- a/doc/html/man/curs_inwstr.3x.html +++ b/doc/html/man/curs_inwstr.3x.html @@ -1,6 +1,6 @@ - -curs_inwstr 3x +curs_inwstr 3x 2024-04-20 ncurses 6.4 Library calls - + -

curs_inwstr 3x

curs_inwstr 3x 2024-04-20 ncurses 6.4 Library calls

-curs_inwstr(3x)                                                curs_inwstr(3x)
+curs_inwstr(3x)                  Library calls                 curs_inwstr(3x)

NAME

        inwstr,  innwstr,  winwstr,  winnwstr,  mvinwstr, mvinnwstr, mvwinwstr,
-       mvwinnwstr - get a string of wchar_t characters from a curses window
+       mvwinnwstr - get a wide-character string from a curses window

SYNOPSIS

@@ -58,6 +58,7 @@
        int innwstr(wchar_t *wstr, int n);
        int winwstr(WINDOW *win, wchar_t *wstr);
        int winnwstr(WINDOW *win, wchar_t *wstr, int n);
+
        int mvinwstr(int y, int x, wchar_t *wstr);
        int mvinnwstr(int y, int x, wchar_t *wstr, int n);
        int mvwinwstr(WINDOW *win, int y, int x, wchar_t *wstr);
@@ -66,50 +67,69 @@

DESCRIPTION

        These routines return a string of  wchar_t  wide  characters  in  wstr,
-       extracted starting at the current cursor position in the named window.
+       starting at the current cursor position in the named window.
 
-       The  four  functions  with n as the last argument return a leading sub-
-       string at most n characters  long  (exclusive  of  the  trailing  NUL).
+       The  four  functions  with  n  as  the  last  argument return a leading
+       substring at most n characters long (exclusive of  the  trailing  NUL).
        Transfer  stops  at  the  end of the current line, or when n characters
        have been stored at the location referenced by wstr.
 
-       If the size n is not large enough to store a complete  complex  charac-
-       ter, an error is generated.
+       If the size  n  is  not  large  enough  to  store  a  complete  complex
+       character, an error is generated.
+
+
+

RETURN VALUE

+       All  routines return ERR upon failure.  Upon successful completion, the
+       *inwstr routines return OK, and the *innwstr routines return the number
+       of characters read into the string.
+
+       X/Open  defines  no  error  conditions.  This implementation returns an
+       error
+
+       o   if the win parameter is null or
+
+       o   if the wstr parameter is null, or
+
+       o   if no characters could be read.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.

NOTES

        All routines except winnwstr may be macros.
 
-       Each cell in the window holds a complex character (i.e., base- and com-
-       bining-characters) together with attributes and color.  These functions
-       store  only  the  wide  characters, ignoring attributes and color.  Use
-       in_wchstr to return the complex characters from a window.
+       Each  cell in the window holds a complex character (a spacing character
+       and zero or more non-spacing characters) together with  attributes  and
+       color.   These  functions  store  only  the  wide  characters, ignoring
+       attributes and color.  Use in_wchstr to return the  complex  characters
+       from a window.
 
+       Reading a line that overflows the array pointed to by wstr with inwstr,
+       mvinwstr, mvwinwstr or winwstr causes  undefined  results.   Therefore,
+       the use of innwstr, mvinnwstr, mvwinnwstr, or winnwstr is recommended.
 
-

RETURN VALUE

-       All routines return ERR upon failure.  Upon successful completion,  the
-       *inwstr routines return OK, and the *innwstr routines return the number
-       of characters read into the string.
 
-       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.
+

PORTABILITY

+       These functions are described in X/Open Curses, Issue 4.