ncurses 5.7 - patch 20090912
[ncurses.git] / man / curs_addstr.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2003,2005 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.13 2005/05/15 16:17:14 tom Exp $
30 .TH curs_addstr 3X ""
31 .na
32 .hy 0
33 .SH NAME
34 \fBaddstr\fR,
35 \fBaddnstr\fR,
36 \fBwaddstr\fR,
37 \fBwaddnstr\fR,
38 \fBmvaddstr\fR,
39 \fBmvaddnstr\fR,
40 \fBmvwaddstr\fR,
41 \fBmvwaddnstr\fR - add a string of characters to a \fBcurses\fR window and advance cursor
42 .ad
43 .hy
44 .SH SYNOPSIS
45 .nf
46 \fB#include <curses.h>\fR
47 .PP
48 \fBint addstr(const char *\fR\fIstr\fR\fB);\fR
49 .br
50 \fBint addnstr(const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
51 .br
52 \fBint waddstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB);\fR
53 .br
54 \fBint waddnstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
55 .br
56 \fBint mvaddstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
57 .br
58 \fBint mvaddnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
59 .br
60 \fBint mvwaddstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
61 .br
62 \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
63 .fi
64 .SH DESCRIPTION
65 These routines write the characters of the (null-terminated) character string
66 \fIstr\fR on the given window.
67 It is similar to calling \fBwaddch\fR once for each character in the string.
68 The four routines with \fIn\fR as the last argument
69 write at most \fIn\fR characters.
70 If \fIn\fR is -1, then the entire string will be added,
71 up to the maximum number of characters that will fit on the line,
72 or until a terminating null is reached.
73 .SH RETURN VALUE
74 All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success
75 (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon
76 successful completion.
77 .PP
78 X/Open does not define any error conditions.
79 This implementation returns an error
80 if the window pointer is null or
81 if the string pointer is null or
82 if the corresponding calls to \fBwaddch\fP return an error.
83 .SH NOTES
84 Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be
85 macros.
86 .SH PORTABILITY
87 All these entry points are described in the XSI Curses standard, Issue 4.  The
88 XSI errors EILSEQ and EOVERFLOW, associated with extended-level conformance,
89 are not yet detected.
90 .SH SEE ALSO
91 \fBcurses\fR(3X), \fBcurs_addch\fR(3X).
92 .\"#
93 .\"# The following sets edit modes for GNU EMACS
94 .\"# Local Variables:
95 .\"# mode:nroff
96 .\"# fill-column:79
97 .\"# End: