X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=50a8ce5b62f89fde0c6aa805d6842d42894352db;hb=HEAD;hp=ad755d8cdef2f7034eb76a5e6ce1b0b241f55cc3;hpb=b0b1980be11bba618d84beb8b30ac94e2c820602;p=ncurses.git diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index ad755d8c..da46ecfa 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 2024-05-25 ncurses 6.5 Library calls + + -

curs_addstr 3x

-
+

curs_addstr 3x 2024-05-25 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
+

NAME

+       addstr,  addnstr,  waddstr,  waddnstr,  mvaddstr, mvaddnstr, mvwaddstr,
+       mvwaddnstr - add a string to a curses window and advance the cursor
 
 
-
-

SYNOPSIS

+

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.
 
-       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.
+

DESCRIPTION

+       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  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.
+       waddnstr writes at most n  characters,  or  until  a  terminating  null
+       character  occurs  in  str.   If  n  is  -1, waddnstr writes the entire
+       string.
 
+       ncurses(3x) describes the variants of these functions.
 
-
-

RETURN VALUE

-       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
+

RETURN VALUE

+       These functions return OK on success and ERR on failure.
 
-       o   if the window pointer is null or
+       In ncurses, they return ERR if
 
-       o   if the string pointer is null or
+       o   win is NULL,
 
-       o   if the corresponding calls to waddch return an error.
+       o   str is NULL, or
 
-       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   an internal waddch(3x) call returns ERR.
 
+       Functions prefixed with "mv" first perform cursor movement and fail  if
+       the position (y, x) is outside the window boundaries.
 
-
-

NOTES

+
+

NOTES

        All of these functions except waddnstr may be macros.
 
 
-
-

PORTABILITY

-       These  functions are described in the XSI Curses standard,
-       Issue 4.
+

PORTABILITY

+       X/Open  Curses,  Issue  4  describes  these functions.  It specifies no
+       error conditions for them.
 
 
-
-

SEE ALSO

-       curses(3x), curs_addch(3x).
+

SEE ALSO

+       curs_addwstr(3x) describes comparable functions of the ncurses  library
+       in its wide-character configuration (ncursesw).
+
+       curses(3x), curs_addch(3x), curs_addchstr(3x)
 
 
 
-                                                        curs_addstr(3x)
+ncurses 6.5                       2024-05-25                   curs_addstr(3x)
-
-Man(1) output converted with man2html +
+ +