3859a34b8b429dd6a13dd48e31ca564495e0da2e
[ncurses.git] / man / curs_addstr.3x
1 .TH curs_addstr 3X ""
2 .SH NAME
3 \fBaddstr\fR, \fBaddnstr\fR, \fBwaddstr\fR, \fBwaddnstr\fR,
4 \fBmvaddstr\fR, \fBmvaddnstr\fR, \fBmvwaddstr\fR, \fBmvwaddnstr\fR - add a
5 string of characters to a \fBcurses\fR window and advance cursor
6 .SH SYNOPSIS
7 \fB#include <curses.h>\fR
8
9 \fBint addstr(const char *str);\fR
10 .br
11 \fBint addnstr(const char *str, int n);\fR
12 .br
13 \fBint waddstr(WINDOW *win, const char *str);\fR
14 .br
15 \fBint waddnstr(WINDOW *win, const char *str, int n);\fR
16 .br
17 \fBint mvaddstr(int y, int x, const char *str);\fR
18 .br
19 \fBint mvaddnstr(int y, int x, const char *str, int n);\fR
20 .br
21 \fBint mvwaddstr(WINDOW *win, int y, int x, const char *str);\fR
22 .br
23 \fBint mvwaddnstr(WINDOW *win, int y, int x, const char *str, int n);\fR
24 .SH DESCRIPTION
25 These routines write the characters of the (null-terminated) character string
26 \fIstr\fR on the given window.  It is similar to calling \fBwaddch\fR once for
27 each character in the string.  The four routines with \fIn\fR as the last
28 argument write at most \fIn\fR characters.  If \fIn\fR is -1, then the
29 entire string will be added.
30 .SH RETURN VALUE
31 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success
32 (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon
33 successful completion.
34 .SH NOTES
35 Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be
36 macros.
37 .SH PORTABILITY
38 All these entry points are described in the XSI Curses standard, Issue 4.  The
39 XSI errors EILSEQ and EOVERFLOW, associated with extended-level conformance,
40 are not yet detected.
41 .SH SEE ALSO
42 \fBcurses\fR(3X), \fBcurs_addch\fR(3X).
43 .\"#
44 .\"# The following sets edit modes for GNU EMACS
45 .\"# Local Variables:
46 .\"# mode:nroff
47 .\"# fill-column:79
48 .\"# End: