X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=06f613374eda6ae1f650b57a43bbc49ccaa46c13;hp=57ebeb6caff716adcb6773e53240c51bb6937c40;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index 57ebeb6c..06f61337 100644 --- a/doc/html/man/curs_addstr.3x.html +++ b/doc/html/man/curs_addstr.3x.html @@ -1,7 +1,7 @@ - - +
-- -curs_addstr(3x) curs_addstr(3x) +curs_addstr(3X) curs_addstr(3X) --
- addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr, - mvwaddstr, mvwaddnstr - add a string of characters to a - curses window and advance cursor +
+ addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr, mvwaddstr, + mvwaddnstr - add a string of characters to a curses window and advance + cursor --
- #include <curses.h> +
+ #include <curses.h> - int addstr(const char *str); - int addnstr(const char *str, int n); - int waddstr(WINDOW *win, const char *str); - int waddnstr(WINDOW *win, const char *str, int n); - int mvaddstr(int y, int x, const char *str); - int mvaddnstr(int y, int x, const char *str, int n); - int mvwaddstr(WINDOW *win, int y, int x, const char *str); - int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n); + int addstr(const char *str); + int addnstr(const char *str, int n); + int waddstr(WINDOW *win, const char *str); + int waddnstr(WINDOW *win, const char *str, int n); + int mvaddstr(int y, int x, const char *str); + int mvaddnstr(int y, int x, const char *str, int n); + int mvwaddstr(WINDOW *win, int y, int x, const char *str); + int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n); --
- These routines write the characters of the (null-termi- - nated) character string str on the given window. It is - similar to calling waddch once for each character in the - string. The four routines with n as the last argument - write at most n characters. If n is -1, then the entire - string will be added, up to the maximum number of charac- - ters that will fit on the line, or until a terminating - null is reached. +
+ These functions write the (null-terminated) character string str on the + given window. It is similar to calling waddch once for each byte in + the string. --
- 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. + The mv functions perform cursor movement once, before writing any char- + acters. Thereafter, the cursor is advanced as a side-effect of writing + to the window. + The four functions with n as the last argument write at most n bytes, + or until a terminating null is reached. If n is -1, then the entire + string will be added. --
- Note that all of these routines except waddstr and - waddnstr may be macros. +
+ All functions return the integer ERR upon failure and OK on success. --
- All these entry points are described in the XSI Curses - standard, Issue 4. The XSI errors EILSEQ and EOVERFLOW, - associated with extended-level conformance, are not yet - detected. + X/Open does not define any error conditions. This implementation re- + turns an error + o if the window pointer is null or --
- curses(3x), curs_addch(3x). + o if the string pointer is null or + + o if the corresponding calls to waddch return an error. + + 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. If an error is returned by the wmove, no + characters are added to the window. + + If an error is returned by waddch (e.g., because the window is not + large enough, or an illegal byte sequence was detected) only part of + the string may be added. Aside from that, there is a special case in + waddch where an error may be returned after successfully writing a + character to the lower-right corner of a window when scrollok is dis- + abled. + + +
+ All of these functions except waddnstr may be macros. + + +
+ These functions are described in the XSI Curses standard, Issue 4. + + +
+ curses(3X), curs_addch(3X). - curs_addstr(3x) + curs_addstr(3X)-