X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=78abdeb98658371fa945851c4d2ef9e577d6678e;hp=43f244dea015249ccad731809929ab9961ac4ad2;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index 43f244de..78abdeb9 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,80 +1,131 @@ + + + + + +curs_addchstr 3x + + + +

curs_addchstr 3x

-
+curs_addchstr(3x)                                            curs_addchstr(3x)
 
-
-

NAME

-       addchstr,  addchnstr,  waddchstr,  waddchnstr, mvaddchstr,
-       mvaddchnstr, mvwaddchstr, mvwaddchnstr - add a  string  of
-       characters (and attributes) to a curses 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);
+

NAME

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

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

SYNOPSIS

+       #include <curses.h>
 
-       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.
+       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);
 
 
-
-

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

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.
 
+       The  window  cursor  is not advanced.  These functions work faster than
+       waddnstr.  On the other hand:
 
-
-

NOTES

-       Note that all routines except waddchnstr may be macros.
+       o   they do not perform checking (such as for the  newline,  backspace,
+           or carriage return characters),
 
+       o   they do not advance the current cursor position,
 
-
-

PORTABILITY

-       All  these  entry  points  are described in the XSI Curses
-       standard, Issue 4.
+       o   they do not expand other control characters to ^-escapes, and
 
+       o   they  truncate  the  string  if it crosses the right margin, rather
+           than wrapping it around to the new line.
+
+
+

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

NOTES

+       All functions except waddchnstr may be macros.
+
+
+

PORTABILITY

+       These entry points are described in the XSI Curses standard, Issue 4.
+
+
+

SEE ALSO

+       curses(3x), curs_addstr(3x).
+
+       Comparable  functions  in the wide-character (ncursesw) library are de-
+       scribed in curs_add_wchstr(3x).
 
-
-

SEE ALSO

-       curses(3x).
 
 
+                                                             curs_addchstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +