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=43f244dea015249ccad731809929ab9961ac4ad2;hb=HEAD;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index 43f244de..8f3b5b68 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,80 +1,134 @@ + + +
+ + +- +curs_addchstr(3x) Library calls curs_addchstr(3x) --
- addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, - mvaddchnstr, mvwaddchstr, mvwaddchnstr - add a string of - characters (and attributes) to a curses window --
- #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); +
+ addchstr, addchnstr, waddchstr, waddchnstr, mvaddchstr, mvaddchnstr, + mvwaddchstr, mvwaddchnstr - add a curses character string to a window --
- 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. +
+ #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 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); --
- 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. +
+ 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. --
- Note that all routines except waddchnstr may be macros. + 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, + or carriage return characters), --
- All these entry points are described in the XSI Curses - standard, Issue 4. + o they do not advance the current cursor position, + 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. + + +
+ All functions return the integer ERR upon failure and OK on success. + + 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 prefixed with "mv" first perform cursor movement and fail if + the position (y, x) is outside the window boundaries. + + +
+ All functions except waddchnstr may be macros. + + +
+ These functions are described in X/Open Curses, Issue 4. + + +
+ 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) --
- curses(3x). +ncurses 6.4 2024-04-20 curs_addchstr(3x)-