ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / curs_addstr.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2019,2020 Thomas E. Dickey                                     *
4   * Copyright 1998-2012,2017 Free Software Foundation, Inc.                  *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_addstr.3x,v 1.23 2020/10/17 23:11:02 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_addstr 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_addstr 3X</H1>
43 <PRE>
44 <B><A HREF="curs_addstr.3X.html">curs_addstr(3X)</A></B>                                                <B><A HREF="curs_addstr.3X.html">curs_addstr(3X)</A></B>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <B>addstr</B>, <B>addnstr</B>, <B>waddstr</B>, <B>waddnstr</B>, <B>mvaddstr</B>, <B>mvaddnstr</B>, <B>mvwaddstr</B>,
51        <B>mvwaddnstr</B> - add a string of characters to a <B>curses</B> window and advance
52        cursor
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <B>#include</B> <B>&lt;curses.h&gt;</B>
57
58        <B>int</B> <B>addstr(const</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
59        <B>int</B> <B>addnstr(const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
60        <B>int</B> <B>waddstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
61        <B>int</B> <B>waddnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
62
63        <B>int</B> <B>mvaddstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
64        <B>int</B> <B>mvaddnstr(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
65        <B>int</B> <B>mvwaddstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
66        <B>int</B> <B>mvwaddnstr(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>str,</I> <I>int</I> <I>n</I><B>);</B>
67
68
69 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
70        These functions write the (null-terminated) character string <I>str</I> on the
71        given window.  It is similar to calling <B>waddch</B> once for  each  byte  in
72        the string.
73
74        The <I>mv</I> functions perform cursor movement once, before writing any char-
75        acters.  Thereafter, the cursor is advanced as a side-effect of writing
76        to the window.
77
78        The  four  functions with <I>n</I> as the last argument write at most <I>n</I> bytes,
79        or until a terminating null is reached.  If <I>n</I> is -1,  then  the  entire
80        string will be added.
81
82
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84        All functions return the integer <B>ERR</B> upon failure and <B>OK</B> on success.
85
86        X/Open  does  not define any error conditions.  This implementation re-
87        turns an error
88
89        <B>o</B>   if the window pointer is null or
90
91        <B>o</B>   if the string pointer is null or
92
93        <B>o</B>   if the corresponding calls to <B>waddch</B> return an error.
94
95        Functions with a "mv" prefix first  perform  a  cursor  movement  using
96        <B>wmove</B>, and return an error if the position is outside the window, or if
97        the window pointer is null.  If an error is returned by the  <B>wmove</B>,  no
98        characters are added to the window.
99
100        If  an  error  is  returned  by <B>waddch</B> (e.g., because the window is not
101        large enough, or an illegal byte sequence was detected)  only  part  of
102        the  string  may be added.  Aside from that, there is a special case in
103        <B>waddch</B> where an error may be  returned  after  successfully  writing  a
104        character  to  the lower-right corner of a window when <B>scrollok</B> is dis-
105        abled.
106
107
108 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
109        All of these functions except <B>waddnstr</B> may be macros.
110
111
112 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These functions are described in the XSI Curses standard, Issue 4.
114
115
116 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
117        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_addch.3X.html">curs_addch(3X)</A></B>.
118
119
120
121                                                                <B><A HREF="curs_addstr.3X.html">curs_addstr(3X)</A></B>
122 </PRE>
123 <div class="nav">
124 <ul>
125 <li><a href="#h2-NAME">NAME</a></li>
126 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
127 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
128 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
129 <li><a href="#h2-NOTES">NOTES</a></li>
130 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
132 </ul>
133 </div>
134 </BODY>
135 </HTML>