X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addchstr.3x.html;h=8c492fa1608d9d8745e10ef260272d8f6b284ebf;hp=e8861399946af891b70e87cad3938634b4fcf347;hb=74137fec04e130a88ef25618cf730af988a4f51a;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011 diff --git a/doc/html/man/curs_addchstr.3x.html b/doc/html/man/curs_addchstr.3x.html index e8861399..8c492fa1 100644 --- a/doc/html/man/curs_addchstr.3x.html +++ b/doc/html/man/curs_addchstr.3x.html @@ -1,7 +1,6 @@ - +
+ +- -curs_addchstr(3x) curs_addchstr(3x) +curs_addchstr(3x) curs_addchstr(3x) --
- 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 string of characters (and attributes) + to a curses window --
+
#include <curses.h> int addchstr(const chtype *chstr); @@ -62,72 +60,70 @@ 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); --
- 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 do not per- - form any kind of checking (such as for the newline, - backspace, or carriage return characters), they do not ad- - vance the current cursor position, they do not expand oth- - er control characters to ^-escapes, and they truncate the - string if it crosses the right margin, rather than wrap- - ping it around to the new line. +
+ 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: --
- 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 they do not perform checking (such as for the newline, backspace, + or carriage return characters), - X/Open does not define any error conditions. This imple- - mentation returns an error if the window pointer is null. + o they do not advance the current cursor position, - 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. + 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. --
- Note that all routines except waddchnstr may be macros. +
+ All functions return the integer ERR upon failure and OK on success. --
- These entry points are described in the XSI Curses stan- - dard, Issue 4. + 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. --
- curses(3x). - Comparable functions in the wide-character (ncursesw) li- - brary are described in curs_add_wchstr(3x). +
+ All functions except waddchnstr may be macros. + + +
+ These entry points are described in the XSI Curses standard, Issue 4. + + +
+ curs_addstr(3x), curses(3x). + + Comparable functions in the wide-character (ncursesw) library are de- + scribed in curs_add_wchstr(3x). - curs_addchstr(3x) + curs_addchstr(3x)-