X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=50a8ce5b62f89fde0c6aa805d6842d42894352db;hp=9442c6ba2420728d50f66f0aa3a209118ce9d916;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012 diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index 9442c6ba..50a8ce5b 100644 --- a/doc/html/man/curs_addstr.3x.html +++ b/doc/html/man/curs_addstr.3x.html @@ -1,6 +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> 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 functions write the (null-terminated) character - string str on the given window. It is similar to calling - waddch once for each character in the string. +
+ 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. - The mv functions perform cursor movement once, before - writing any characters. Thereafter, the cursor is ad- - vanced as a side-effect of writing to the window. + 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 characters, or until a terminating null is reached. - If n is -1, then the entire string will be added. + 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. --
- All functions return the integer ERR upon failure and OK - on success. +
+ 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 + X/Open does not define any error conditions. This implementation re- + turns an error o if the window pointer is null or @@ -96,29 +92,33 @@ o if the corresponding calls to waddch return an error. - 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. + 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. +
+ These functions are described in the XSI Curses standard, Issue 4. --
+
curses(3x), curs_addch(3x). - curs_addstr(3x) + curs_addstr(3x)