X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_in_wchstr.3x.html;h=74a3b4bfafbb6201557e45fb110f4edb56fa6691;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=b2f36ff5911b4cc068e7c0289f2a0c6d6b3be17e;hpb=7e062bb2764a87d98073a90ee65a234a2679f9c1;p=ncurses.git diff --git a/doc/html/man/curs_in_wchstr.3x.html b/doc/html/man/curs_in_wchstr.3x.html index b2f36ff5..74a3b4bf 100644 --- a/doc/html/man/curs_in_wchstr.3x.html +++ b/doc/html/man/curs_in_wchstr.3x.html @@ -1,6 +1,6 @@ -curs_in_wchstr 3x 2023-09-30 ncurses 6.4 Library calls +curs_in_wchstr 3x 2024-05-25 ncurses 6.5 Library calls -

curs_in_wchstr 3x 2023-09-30 ncurses 6.4 Library calls

+

curs_in_wchstr 3x 2024-05-25 ncurses 6.5 Library calls

 curs_in_wchstr(3x)               Library calls              curs_in_wchstr(3x)
 
@@ -56,14 +56,14 @@
        #include <curses.h>
 
        int in_wchstr(cchar_t *wchstr);
-       int in_wchnstr(cchar_t *wchstr, int n);
        int win_wchstr(WINDOW *win, cchar_t *wchstr);
-       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
-
        int mvin_wchstr(int y, int x, cchar_t *wchstr);
-       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
        int mvwin_wchstr(WINDOW *win, int y, int x, cchar_t *wchstr);
-       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);
+
+       int in_wchnstr(cchar_t *wchstr, int n);
+       int win_wchnstr(WINDOW *win, cchar_t *wchstr, int n);
+       int mvin_wchnstr(int y, int x, cchar_t *wchstr, int n);
+       int mvwin_wchnstr(WINDOW *win, int y, int x, cchar_t *wchstr, int n);

DESCRIPTION

@@ -71,48 +71,62 @@
        starting  at  the  current  cursor  position  in  the   named   window.
        Attributes (rendition) are stored with the characters.
 
-       The  in_wchnstr,  mvin_wchnstr,  mvwin_wchnstr and win_wchnstr fill the
-       array with at most n cchar_t elements.
-
+       The  four  functions  with  n  as  the  last  argument return a leading
+       substring at most n characters long (exclusive of the  trailing  zeroed
+       cchar_t.   Transfer  stops  at  the  end of the current line, or when n
+       characters have been stored at the location referenced by wchstr.
 
-

NOTES

-       Note that all routines except win_wchnstr may be macros.
-
-       Reading a line that overflows the  array  pointed  to  by  wchstr  with
-       in_wchstr,  mvin_wchstr,  mvwin_wchstr  or  win_wchstr causes undefined
-       results.    Therefore,   the   use   of    in_wchnstr,    mvin_wchnstr,
-       mvwin_wchnstr, or win_wchnstr is recommended.
+       Constants defined in <curses.h> can be used with the  &  (logical  AND)
+       operator  to  extract  the  character  or  the attribute alone from any
+       position in the wchstr [see getcchar(3x)].

RETURN VALUE

        Upon successful completion, these functions return OK.  Otherwise, they
        return ERR.
 
-       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.
+       X/Open Curses defines no error conditions.  This implementation returns
+       ERR
+
+       o   if the win parameter is null or
+
+       o   if the wchstr parameter is null.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

+       All routines except win_wchnstr may be macros.
+
+       Reading  a  line  that  overflows  the  array pointed to by wchstr with
+       in_wchstr, mvin_wchstr, mvwin_wchstr  or  win_wchstr  causes  undefined
+       results.     Therefore,    the   use   of   in_wchnstr,   mvin_wchnstr,
+       mvwin_wchnstr, or win_wchnstr is recommended.

PORTABILITY

-       The XSI Curses defines no error conditions.  This implementation checks
+       X/Open Curses defines no error conditions.  This implementation  checks
        for null pointers, returning ERR in that case.

SEE ALSO

-       curses(3x),     curs_in_wch(3x),     curs_instr(3x),    curs_inwstr(3x)
-       curs_inchstr(3x)
+       curs_inchstr(3x)  describes comparable functions of the ncurses library
+       in its non-wide-character configuration.
+
+       curses(3x), curs_inwstr(3x), curs_in_wch(3x)
 
 
 
-ncurses 6.4                       2023-09-30                curs_in_wchstr(3x)
+ncurses 6.5                       2024-05-25                curs_in_wchstr(3x)