1 .\"***************************************************************************
2 .\" Copyright 2019-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2012,2017 Free Software Foundation, Inc. *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a *
6 .\" copy of this software and associated documentation files (the *
7 .\" "Software"), to deal in the Software without restriction, including *
8 .\" without limitation the rights to use, copy, modify, merge, publish, *
9 .\" distribute, distribute with modifications, sublicense, and/or sell *
10 .\" copies of the Software, and to permit persons to whom the Software is *
11 .\" furnished to do so, subject to the following conditions: *
13 .\" The above copyright notice and this permission notice shall be included *
14 .\" in all copies or substantial portions of the Software. *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" Except as contained in this notice, the name(s) of the above copyright *
25 .\" holders shall not be used in advertising or otherwise to promote the *
26 .\" sale, use or other dealings in this Software without prior written *
28 .\"***************************************************************************
30 .\" $Id: curs_addstr.3x,v 1.51 2024/06/22 21:26:53 tom Exp $
31 .TH curs_addstr 3X 2024-06-22 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
56 add a string to a \fIcurses\fR window and advance the cursor
59 \fB#include <curses.h>
61 \fBint addstr(const char *\fIstr\fP);
62 \fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
63 \fBint mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
64 \fBint waddstr(WINDOW *\fIwin\fP, const char *\fIstr\fP);
66 \fBint addnstr(const char *\fIstr\fP, int \fIn\fP);
67 \fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
68 \fBint mvwaddnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
69 \fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP);
73 writes the characters of the (null-terminated) string
77 Its process is similar to calling \fB\%waddch\fP(3X) for each
81 Control characters are processed as in \fB\%waddch\fP(3X).
87 or until a terminating null character occurs in
94 writes the entire string.
96 \fB\%ncurses\fP(3X) describes the variants of these functions.
98 These functions return
119 an internal \fB\%waddch\fP(3X) call returns
122 Functions prefixed with \*(``mv\*('' first perform cursor movement and
126 is outside the window boundaries.
128 All of these functions except \fBwaddnstr\fP may be macros.
131 Issue 4 describes these functions.
132 It specifies no error conditions for them.
138 along with its variants,
139 the latter defined as macros.
147 as a macro wrapping it.
149 \fB\%curs_addwstr\fP(3X) describes comparable functions of the
151 library in its wide-character configuration
155 \fB\%curs_addch\fP(3X),
156 \fB\%curs_addchstr\fP(3X)