X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=b9ee20aae6b90c151fa5464ed2d50a390fd1c1a1;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=04bbdbeab0ac7e64c10291680cf9ddd5d9627be1;hpb=7e062bb2764a87d98073a90ee65a234a2679f9c1;p=ncurses.git diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index 04bbdbea..b9ee20aa 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,6 +1,6 @@ -curs_addchstr 3x 2023-09-30 ncurses 6.4 Library calls +curs_addchstr 3x 2024-06-01 ncurses 6.5 Library calls -

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

+

curs_addchstr 3x 2024-06-01 ncurses 6.5 Library calls

 curs_addchstr(3x)                Library calls               curs_addchstr(3x)
 
@@ -55,65 +55,68 @@
        #include <curses.h>
 
        int addchstr(const chtype *chstr);
-       int addchnstr(const chtype *chstr, int n);
        int waddchstr(WINDOW *win, const chtype *chstr);
-       int waddchnstr(WINDOW *win, const chtype *chstr, int n);
-
        int mvaddchstr(int y, int x, const chtype *chstr);
-       int mvaddchnstr(int y, int x, const chtype *chstr, int n);
        int mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);
+
+       int addchnstr(const chtype *chstr, int n);
+       int waddchnstr(WINDOW *win, const chtype *chstr, int n);
+       int mvaddchnstr(int y, int x, const chtype *chstr, int n);
        int mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);

DESCRIPTION

-       These functions copy the (null-terminated) chstr array into the  window
-       image  structure  starting  at  the  current cursor position.  The four
-       functions with n as the last argument copy at most n elements,  but  no
-       more  than  will  fit  on  the  line.   If n=-1 then the whole array is
-       copied, to the maximum number of characters that will fit on the line.
+       waddchstr copies the string of curses characters chstr  to  the  window
+       win.   A  null curses character terminates the string.  waddchnstr does
+       the same, but copies at most n characters, or as many as possible if  n
+       is -1.  ncurses(3x) describes the variants of these functions.
 
-       The window cursor is not advanced.  These functions  work  faster  than
-       waddnstr.  On the other hand:
+       Because  these  functions  do  not call waddch(3x) internally, they are
+       faster than waddstr(3x) and waddnstr(3x).  On the other hand, they
 
-       o   they  do  not perform checking (such as for the newline, backspace,
-           or carriage return characters),
+       o   do  not  treat  the  backspace,  carriage  return,  or  line   feed
+           characters specially;
 
-       o   they do not advance the current cursor position,
+       o   do not represent unprintable characters with unctrl(3x);
 
-       o   they do not expand other control characters to ^-escapes, and
+       o   do  not  update  the  cursor  position to follow the last character
+           written;
 
-       o   they truncate the string if it crosses  the  right  margin,  rather
-           than wrapping it around to the new line.
+       o   truncate the string at  the  window's  right  margin,  rather  than
+           wrapping it to the next line and potentially scrolling.

RETURN VALUE

-       All functions return the integer ERR upon failure and OK on success.
+       These functions return OK on success and ERR on failure.
+
+       X/Open  Curses  does not specify any error conditions.  ncurses returns
+       ERR if
+
+       o   win is NULL or
 
-       X/Open  does  not  define  any  error  conditions.  This implementation
-       returns an error if the window pointer is null.
+       o   chstr is NULL.
 
-       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

-       All functions except waddchnstr may be macros.
+       All of these functions except waddchnstr may be implemented as macros.

PORTABILITY

-       These entry points are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes these functions.

SEE ALSO

-       curses(3x), curs_addstr(3x)
+       curs_add_wchstr(3x)  describes  comparable  functions  of  the  ncurses
+       library in its wide-character configuration (ncursesw).
 
-       Comparable functions  in  the  wide-character  (ncursesw)  library  are
-       described in curs_add_wchstr(3x).
+       curses(3x), curs_addch(3x), curs_addstr(3x)
 
 
 
-ncurses 6.4                       2023-09-30                 curs_addchstr(3x)
+ncurses 6.5                       2024-06-01                 curs_addchstr(3x)