2 ****************************************************************************
3 * Copyright (c) 1998-2010,2012 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 ****************************************************************************
29 * @Id: curs_addstr.3x,v 1.17 2012/11/03 22:57:31 tom Exp @
31 <!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv=
"Content-Type" content=
"text/html; charset=us-ascii">
35 <meta name=
"generator" content=
"Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_addstr
3x
</TITLE>
37 <link rev=made
href=
"mailto:bug-ncurses@gnu.org">
38 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
41 <H1 class=
"no-header">curs_addstr
3x
</H1>
43 <STRONG><A HREF=
"curs_addstr.3x.html">curs_addstr(
3x)
</A></STRONG> <STRONG><A HREF=
"curs_addstr.3x.html">curs_addstr(
3x)
</A></STRONG>
49 <H2><a name=
"h2-NAME">NAME
</a></H2><PRE>
50 <STRONG>addstr
</STRONG>,
<STRONG>addnstr
</STRONG>,
<STRONG>waddstr
</STRONG>,
<STRONG>waddnstr
</STRONG>,
<STRONG>mvaddstr
</STRONG>,
<STRONG>mvaddnstr
</STRONG>,
51 <STRONG>mvwaddstr
</STRONG>,
<STRONG>mvwaddnstr
</STRONG> - add a string of characters to a
52 <STRONG>curses
</STRONG> window and advance cursor
56 <H2><a name=
"h2-SYNOPSIS">SYNOPSIS
</a></H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
59 <STRONG>int
</STRONG> <STRONG>addstr(const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>);
</STRONG>
60 <STRONG>int
</STRONG> <STRONG>addnstr(const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
61 <STRONG>int
</STRONG> <STRONG>waddstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>);
</STRONG>
62 <STRONG>int
</STRONG> <STRONG>waddnstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
63 <STRONG>int
</STRONG> <STRONG>mvaddstr(int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>);
</STRONG>
64 <STRONG>int
</STRONG> <STRONG>mvaddnstr(int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>n
</EM><STRONG>);
</STRONG>
65 <STRONG>int
</STRONG> <STRONG>mvwaddstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str
</EM><STRONG>);
</STRONG>
66 <STRONG>int
</STRONG> <STRONG>mvwaddnstr(WINDOW
</STRONG> <STRONG>*
</STRONG><EM>win
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>y
</EM><STRONG>,
</STRONG> <STRONG>int
</STRONG> <EM>x
</EM><STRONG>,
</STRONG> <STRONG>const
</STRONG> <STRONG>char
</STRONG> <STRONG>*
</STRONG><EM>str,
</EM> <EM>int
</EM> <EM>n
</EM><STRONG>);
</STRONG>
70 <H2><a name=
"h2-DESCRIPTION">DESCRIPTION
</a></H2><PRE>
71 These functions write the (null-terminated) character
72 string
<EM>str
</EM> on the given window. It is similar to calling
73 <STRONG>waddch
</STRONG> once for each character in the string.
75 The
<EM>mv
</EM> functions perform cursor movement once, before
76 writing any characters. Thereafter, the cursor is ad-
77 vanced as a side-effect of writing to the window.
79 The four functions with
<EM>n
</EM> as the last argument write at
80 most
<EM>n
</EM> characters, or until a terminating null is reached.
81 If
<EM>n
</EM> is -
1, then the entire string will be added.
85 <H2><a name=
"h2-RETURN-VALUE">RETURN VALUE
</a></H2><PRE>
86 All functions return the integer
<STRONG>ERR
</STRONG> upon failure and
<STRONG>OK
</STRONG>
89 X/Open does not define any error conditions. This imple-
90 mentation returns an error
92 <STRONG>o
</STRONG> if the window pointer is null or
94 <STRONG>o
</STRONG> if the string pointer is null or
96 <STRONG>o
</STRONG> if the corresponding calls to
<STRONG>waddch
</STRONG> return an error.
98 Functions with a
"mv" prefix first perform a cursor move-
99 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
100 outside the window, or if the window pointer is null.
104 <H2><a name=
"h2-NOTES">NOTES
</a></H2><PRE>
105 All of these functions except
<STRONG>waddnstr
</STRONG> may be macros.
109 <H2><a name=
"h2-PORTABILITY">PORTABILITY
</a></H2><PRE>
110 These functions are described in the XSI Curses standard,
115 <H2><a name=
"h2-SEE-ALSO">SEE ALSO
</a></H2><PRE>
116 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"curs_addch.3x.html">curs_addch(
3x)
</A></STRONG>.
120 <STRONG><A HREF=
"curs_addstr.3x.html">curs_addstr(
3x)
</A></STRONG>
124 <li><a href=
"#h2-NAME">NAME
</a></li>
125 <li><a href=
"#h2-SYNOPSIS">SYNOPSIS
</a></li>
126 <li><a href=
"#h2-DESCRIPTION">DESCRIPTION
</a></li>
127 <li><a href=
"#h2-RETURN-VALUE">RETURN VALUE
</a></li>
128 <li><a href=
"#h2-NOTES">NOTES
</a></li>
129 <li><a href=
"#h2-PORTABILITY">PORTABILITY
</a></li>
130 <li><a href=
"#h2-SEE-ALSO">SEE ALSO
</a></li>