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=57ebeb6caff716adcb6773e53240c51bb6937c40;hb=HEAD;hpb=a8987e73ec254703634802b4f7ee30d3a485524d diff --git a/doc/html/man/curs_addstr.3x.html b/doc/html/man/curs_addstr.3x.html index 57ebeb6c..ba4c12df 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-04-20 ncurses 6.4 Library calls + + -

curs_addstr 3x

-
+

curs_addstr 3x 2024-04-20 ncurses 6.4 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  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, up to the maximum number of  charac-
-       ters  that  will  fit  on the line, or until a terminating
-       null is reached.
 
+

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

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

NOTES

-       Note  that  all  of  these  routines  except  waddstr  and
-       waddnstr may be macros.
 
+

RETURN VALUE

+       These functions return OK on success and ERR on failure.
 
-
-

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.
+       X/Open Curses does not specify any error conditions.   ncurses  returns
+       an error
 
+       o   if the window pointer is NULL,
 
-
-

SEE ALSO

-       curses(3x), curs_addch(3x).
+       o   if the string pointer is NULL, or
+
+       o   if an internal waddch(3x) call returns an error.
+
+       Functions  prefixed with "mv" first perform cursor movement and fail if
+       the position (y, x) is outside the window boundaries.
+
+
+

NOTES

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

PORTABILITY

+       X/Open Curses, Issue 4 describes these functions.
+
+
+

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.4                       2024-04-20                   curs_addstr(3x)
 
-
-
-Man(1) output converted with -man2html -
+