X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=71abb99e03550756aff7fe58703922c0e9b6e18c;hp=d89503cc8bc9fc4c755bd04e98be2457f13b1466;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=3a935d9991cdf43ebfa952073c9b555f73a3e011 diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index d89503cc..71abb99e 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)                                         curs_addstr(3x)
+curs_addstr(3x)                                                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 of characters to a curses window and advance
+       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);
 
 
-
-

DESCRIPTION

-       These routines write the characters of the (null-terminat-
-       ed) character string str on the given window.  It is simi-
-       lar  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.
+

DESCRIPTION

+       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 char-
+       acters.  Thereafter, the cursor is advanced as a side-effect of writing
+       to the window.
 
-
-

RETURN VALUE

-       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  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.
 
-       X/Open does not define any error conditions.  This  imple-
-       mentation  returns  an error if the window pointer is null
-       or if the string pointer is null or 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.
+

RETURN VALUE

+       All functions return the integer ERR upon failure and OK on success.
 
+       X/Open  does  not define any error conditions.  This implementation re-
+       turns an error
 
-
-

NOTES

-       Note  that  all  of  these  routines  except  waddstr  and
-       waddnstr may be macros.
+       o   if the window pointer is null or
 
+       o   if the string pointer is null or
 
-
-

PORTABILITY

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

SEE ALSO

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

NOTES

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

PORTABILITY

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

SEE ALSO

        curses(3x), curs_addch(3x).
 
 
 
-                                                        curs_addstr(3x)
+                                                               curs_addstr(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +