0ffacc6fa9b7d6a53388d0de128629fe09595eaf
[ncurses.git] / man / curs_addstr.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2000,2003 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_addstr.3x,v 1.11 2003/12/27 18:51:15 tom Exp $
30 .TH curs_addstr 3X ""
31 .SH NAME
32 \fBaddstr\fR,
33 \fBaddnstr\fR,
34 \fBwaddstr\fR,
35 \fBwaddnstr\fR,
36 \fBmvaddstr\fR,
37 \fBmvaddnstr\fR,
38 \fBmvwaddstr\fR,
39 \fBmvwaddnstr\fR - add a string of characters to a \fBcurses\fR window and advance cursor
40 .SH SYNOPSIS
41 .nf
42 \fB#include <curses.h>\fR
43 .PP
44 \fBint addstr(const char *\fR\fIstr\fR\fB);\fR
45 .br
46 \fBint addnstr(const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
47 .br
48 \fBint waddstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB);\fR
49 .br
50 \fBint waddnstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
51 .br
52 \fBint mvaddstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
53 .br
54 \fBint mvaddnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
55 .br
56 \fBint mvwaddstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
57 .br
58 \fBint mvwaddnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr, int \fR\fIn\fR\fB);\fR
59 .fi
60 .SH DESCRIPTION
61 These routines write the characters of the (null-terminated) character string
62 \fIstr\fR on the given window.
63 It is similar to calling \fBwaddch\fR once for each character in the string.
64 The four routines with \fIn\fR as the last argument
65 write at most \fIn\fR characters.
66 If \fIn\fR is -1, then the entire string will be added,
67 up to the maximum number of characters that will fit on the line,
68 or until a terminating null is reached.
69 .SH RETURN VALUE
70 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success
71 (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon
72 successful completion.
73 .SH NOTES
74 Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be
75 macros.
76 .SH PORTABILITY
77 All these entry points are described in the XSI Curses standard, Issue 4.  The
78 XSI errors EILSEQ and EOVERFLOW, associated with extended-level conformance,
79 are not yet detected.
80 .SH SEE ALSO
81 \fBcurses\fR(3X), \fBcurs_addch\fR(3X).
82 .\"#
83 .\"# The following sets edit modes for GNU EMACS
84 .\"# Local Variables:
85 .\"# mode:nroff
86 .\"# fill-column:79
87 .\"# End: