X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=886e7aa778fa2fa8854f86ead0d2e5373d667723;hb=HEAD;hp=18db3f077fc001f79955327889de4764ad4c4348;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index 18db3f07..b9ee20aa 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,7 +1,7 @@ - - + -curs_addchstr 3x - - + + +curs_addchstr 3x 2024-06-01 ncurses 6.5 Library calls + + -

curs_addchstr 3x

-
+

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

-
+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
 
 
-
-

SYNOPSIS

+
+

NAME

+       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 routines copy chstr into the window image  structure
-       at  and  after the current cursor position.  The four rou-
-       tines 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 string is copied, to the maximum number  of  charac-
-       ters that will fit on the line.
 
-       The window cursor is not advanced, and these routines work
-       faster than waddnstr.  On the other hand, they don't  per-
-       form  any  kind  of  checking  (such  as  for the newline,
-       backspace, or  carriage  return  characters),  they  don't
-       advance  the  current  cursor  position, they don't expand
-       other control characters to ^-escapes, and  they  truncate
-       the  string  if  it  crosses the right margin, rather then
-       wrapping it around to the new line.
+

DESCRIPTION

+       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.
 
+       Because  these  functions  do  not call waddch(3x) internally, they are
+       faster than waddstr(3x) and waddnstr(3x).  On the other hand, they
 
+       o   do  not  treat  the  backspace,  carriage  return,  or  line   feed
+           characters specially;
 
-
-

RETURN VALUES

-       All routines return the integer ERR upon failure and OK on
-       success  (the  SVr4 manuals specify only "an integer value
-       other than ERR") upon successful completion, unless other-
-       wise noted in the preceding routine descriptions.
+       o   do not represent unprintable characters with unctrl(3x);
 
+       o   do  not  update  the  cursor  position to follow the last character
+           written;
 
-
-

NOTES

-       Note that all routines except waddchnstr may be macros.
+       o   truncate the string at  the  window's  right  margin,  rather  than
+           wrapping it to the next line and potentially scrolling.
 
 
-
-

PORTABILITY

-       All  these  entry  points  are described in the XSI Curses
-       standard, Issue 4.
+

RETURN VALUE

+       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
+
+       o   chstr is NULL.
+
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

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

PORTABILITY

+       X/Open Curses, Issue 4 describes these functions.
+
+
+

SEE ALSO

+       curs_add_wchstr(3x)  describes  comparable  functions  of  the  ncurses
+       library in its wide-character configuration (ncursesw).
+
+       curses(3x), curs_addch(3x), curs_addstr(3x)
 
-
-

SEE ALSO

-       curses(3x).
 
 
+ncurses 6.5                       2024-06-01                 curs_addchstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +