X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=50a8ce5b62f89fde0c6aa805d6842d42894352db;hp=0b6b4cafcdca34bda819b984c89425d9b0ff4944;hb=HEAD;hpb=06078d3fa68db669ed37178c01873546b4b28745 diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index 0b6b4caf..b7f1c689 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 2024-04-20 ncurses 6.5 Library calls + + -

curs_addstr 3x

curs_addstr 3x 2024-04-20 ncurses 6.5 Library calls

-curs_addstr(3x)                                                curs_addstr(3x)
+curs_addstr(3x)                  Library calls                 curs_addstr(3x)

NAME

-       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 to a curses window and advance the cursor

SYNOPSIS

        #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 waddstr(WINDOW *win, const char *str);
+
+       int addnstr(const char *str, int n);
+       int mvaddnstr(int y, int x, const char *str, int n);
+       int mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);
+       int waddnstr(WINDOW *win, const char *str, int n);

DESCRIPTION

-       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.
+       waddstr writes the characters of the (null-terminated)  string  str  to
+       the  window win.  Its process is similar to calling waddch(3x) for each
+       char in str.  Control characters are processed as in waddch(3x).
 
-       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.
+       waddnstr writes at most n  characters,  or  until  a  terminating  null
+       character  occurs  in  str.   If  n  is  -1, waddnstr writes the entire
+       string.
 
-       The  four functions with n as the last argument write at most n charac-
-       ters, or until a terminating null is reached.  If n is -1, then the en-
-       tire string will be added.
+       ncurses(3x) describes the variants of these functions.

RETURN VALUE

-       All functions return the integer ERR upon failure and OK on success.
+       These functions return OK on success and ERR on failure.
 
-       X/Open  does  not define any error conditions.  This implementation re-
-       turns an error
+       X/Open Curses does not specify any error conditions.   ncurses  returns
+       an error
 
-       o   if the window pointer is null or
+       o   if the window pointer is NULL,
 
-       o   if the string pointer is null or
+       o   if the string pointer is NULL, or
 
-       o   if the corresponding calls to waddch return an error.
+       o   if an internal waddch(3x) call returns 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.
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.

NOTES

@@ -100,15 +98,18 @@

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
+       X/Open Curses, Issue 4 describes these functions.