X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=886e7aa778fa2fa8854f86ead0d2e5373d667723;hp=74ea3f500cc90bb35586339c7a2421bc703258a2;hb=HEAD;hpb=cb4427a16794d98049b4d790b810d62217501f9f diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index 74ea3f50..a3441e6c 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,6 +1,7 @@ - -curs_addchstr 3x +curs_addchstr 3x 2024-04-20 ncurses 6.5 Library calls - + -

curs_addchstr 3x

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

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

NAME

-       addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, mvaddchnstr,
-       mvwaddchstr, mvwaddchnstr - add a string of characters (and attributes)
-       to a curses window
+       addchstr,  addchnstr,  waddchstr,  waddchnstr, mvaddchstr, mvaddchnstr,
+       mvwaddchstr, mvwaddchnstr - add a curses character string to a window

SYNOPSIS

        #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 mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);
+       int addchstr(const chtype *chstr);
+       int waddchstr(WINDOW *win, const chtype *chstr);
+       int mvaddchstr(int y, int x, const chtype *chstr);
+       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
+       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.
 
-       The  window  cursor  is not advanced.  These functions work faster than
+       The  window  cursor  is  not advanced.  These functions are faster than
        waddnstr.  On the other hand:
 
        o   they do not perform checking (such as for the  newline,  backspace,
@@ -88,12 +90,15 @@

RETURN VALUE

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

@@ -101,18 +106,18 @@

PORTABILITY

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