X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_addstr.3x.html;h=f5fd5ebfa2a56f5f11925fdcfca91356fa513a5a;hp=e83e795f01fd65db5191e3dc3b944fca0bd6866d;hb=acc28c6418f43cbf15187f2f1fd9a562d5d96535;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index e83e795f..f5fd5ebf 100644 --- a/doc/html/man/curs_addstr.3x.html +++ b/doc/html/man/curs_addstr.3x.html @@ -1,75 +1,123 @@ + + + +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
+       addstr, addnstr, waddstr, waddnstr, mvaddstr, mvaddnstr,
+       mvwaddstr, mvwaddnstr - add a string of characters to a
+       curses window and advance cursor

SYNOPSIS

-       #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);

DESCRIPTION

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

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 characters, or until a terminating null is reached.
+       If n is -1, then the entire string will be added.
-

NOTES

-       Note  that  all  of  these  routines  except  waddstr  and
-       waddnstr may be macros.
+
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
 
-

-
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 window pointer is null or
 
+       o   if the string pointer is null or
 
-

-
SEE ALSO
-       curses(3x), curs_addch(3x).
-
+       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.
 
 
+

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