1 <!DOCTYPE HTML PUBLIC
"-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_addstr.3x,v 1.16 2010/12/04 18:36:44 tom Exp @
34 <TITLE>curs_addstr
3x
</TITLE>
35 <link rev=made
href=
"mailto:bug-ncurses@gnu.org">
36 <meta http-equiv=
"Content-Type" content=
"text/html; charset=iso-8859-1">
39 <H1>curs_addstr
3x
</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
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>SYNOPSIS
</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>DESCRIPTION
</H2><PRE>
71 These routines write the characters of the (null-terminat-
72 ed) character string
<EM>str
</EM> on the given window. It is simi-
73 lar to calling
<STRONG>waddch
</STRONG> once for each character in the
74 string. The four routines with
<EM>n
</EM> as the last argument
75 write at most
<EM>n
</EM> characters. If
<EM>n
</EM> is -
1, then the entire
76 string will be added, up to the maximum number of charac-
77 ters that will fit on the line, or until a terminating
82 <H2>RETURN VALUE
</H2><PRE>
83 All routines return the integer
<STRONG>ERR
</STRONG> upon failure and
<STRONG>OK
</STRONG> on
84 success (the SVr4 manuals specify only
"an integer value
85 other than <STRONG>ERR</STRONG>") upon successful completion.
87 X/Open does not define any error conditions. This imple-
88 mentation returns an error if the window pointer is null
89 or if the string pointer is null or if the corresponding
90 calls to
<STRONG>waddch
</STRONG> return an error.
92 Functions with a
"mv" prefix first perform a cursor move-
93 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
94 outside the window, or if the window pointer is null.
99 Note that all of these routines except
<STRONG>waddstr
</STRONG> and
100 <STRONG>waddnstr
</STRONG> may be macros.
104 <H2>PORTABILITY
</H2><PRE>
105 All these entry points are described in the XSI Curses
106 standard, Issue
4. The XSI errors EILSEQ and EOVERFLOW,
107 associated with extended-level conformance, are not yet
112 <H2>SEE ALSO
</H2><PRE>
113 <STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>,
<STRONG><A HREF=
"curs_addch.3x.html">curs_addch(
3x)
</A></STRONG>.
117 <STRONG><A HREF=
"curs_addstr.3x.html">curs_addstr(
3x)
</A></STRONG>
121 Man(
1) output converted with
122 <a href=
"http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html
</a>