X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=b4bbc4f84cc9f4546cc93c80e3ecf8d64f9f81a8;hp=486f247d61fa233ed7661731d82ec04d56f28c04;hb=e6f4ffe150c7d919792f29a70b4f031cfab5ef06;hpb=a8987e73ec254703634802b4f7ee30d3a485524d
diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html
index 486f247d..b4bbc4f8 100644
--- a/doc/html/man/curs_addchstr.3x.html
+++ b/doc/html/man/curs_addchstr.3x.html
@@ -1,7 +1,7 @@
-
+
@@ -40,15 +40,15 @@
-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
+ addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr,
+ mvaddchnstr, mvwaddchstr, mvwaddchnstr - add a string of
characters (and attributes) to a curses window
@@ -62,57 +62,68 @@
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 mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);
+ 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.
+ These functions copy the (null-terminated) chstr array in-
+ to the window image structure starting at the current cur-
+ sor position. The four functions with n as the last argu-
+ ment 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:
+
+ 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,
+
+ o they do not expand other control characters to ^-es-
+ capes, and
+
+ o they truncate the string if it crosses the right mar-
+ gin, rather than wrapping it around to the new line.
-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.
+RETURN VALUE
+ All functions return the integer ERR upon failure and OK
+ on success.
+
+ X/Open does not define any error conditions. This imple-
+ mentation returns an error if the window pointer is null.
+
+ Functions with a "mv" prefix first perform a cursor move-
+ ment using wmove, and return an error if the position is
+ outside the window, or if the window pointer is null.
NOTES
- Note that all routines except waddchnstr may be macros.
+ All functions except waddchnstr may be macros.
PORTABILITY
- All these entry points are described in the XSI Curses
- standard, Issue 4.
+ These entry points are described in the XSI Curses stan-
+ dard, Issue 4.
SEE ALSO
- curses(3x).
+ curs_addstr(3x), curses(3x).
+
+ Comparable functions in the wide-character (ncursesw) li-
+ brary are described in curs_add_wchstr(3x).
- curs_addchstr(3x)
+ curs_addchstr(3x)