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_addchstr.3x,v 1.16 2012/11/03 22:54:43 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_addchstr
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_addchstr
3x
</H1>
43 <STRONG><A HREF=
"curs_addchstr.3x.html">curs_addchstr(
3x)
</A></STRONG> <STRONG><A HREF=
"curs_addchstr.3x.html">curs_addchstr(
3x)
</A></STRONG>
49 <H2><a name=
"h2-NAME">NAME
</a></H2><PRE>
50 <STRONG>addchstr
</STRONG>,
<STRONG>addchnstr
</STRONG>,
<STRONG>waddchstr
</STRONG>,
<STRONG>waddchnstr
</STRONG>,
<STRONG>mvaddchstr
</STRONG>,
51 <STRONG>mvaddchnstr
</STRONG>,
<STRONG>mvwaddchstr
</STRONG>,
<STRONG>mvwaddchnstr
</STRONG> - add a string of
52 characters (and attributes) to a
<STRONG>curses
</STRONG> window
56 <H2><a name=
"h2-SYNOPSIS">SYNOPSIS
</a></H2><PRE>
57 <STRONG>#include
</STRONG> <STRONG><curses.h
></STRONG>
59 <STRONG>int
</STRONG> <STRONG>addchstr(const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr);
</STRONG>
60 <STRONG>int
</STRONG> <STRONG>addchnstr(const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
61 <STRONG>int
</STRONG> <STRONG>waddchstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr);
</STRONG>
62 <STRONG>int
</STRONG> <STRONG>waddchnstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
63 <STRONG>int
</STRONG> <STRONG>mvaddchstr(int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr);
</STRONG>
64 <STRONG>int
</STRONG> <STRONG>mvaddchnstr(int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
65 <STRONG>int
</STRONG> <STRONG>mvwaddchstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr);
</STRONG>
66 <STRONG>int
</STRONG> <STRONG>mvwaddchnstr(WINDOW
</STRONG> <STRONG>*win,
</STRONG> <STRONG>int
</STRONG> <STRONG>y,
</STRONG> <STRONG>int
</STRONG> <STRONG>x,
</STRONG> <STRONG>const
</STRONG> <STRONG>chtype
</STRONG> <STRONG>*chstr,
</STRONG> <STRONG>int
</STRONG> <STRONG>n);
</STRONG>
70 <H2><a name=
"h2-DESCRIPTION">DESCRIPTION
</a></H2><PRE>
71 These functions copy the (null-terminated)
<EM>chstr
</EM> array in-
72 to the window image structure starting at the current cur-
73 sor position. The four functions with
<EM>n
</EM> as the last argu-
74 ment copy at most
<EM>n
</EM> elements, but no more than will fit on
75 the line. If
<STRONG>n
</STRONG>=
<STRONG>-
1</STRONG> then the whole array is copied, to the
76 maximum number of characters that will fit on the line.
78 The window cursor is
<EM>not
</EM> advanced. These functions work
79 faster than
<STRONG>waddnstr
</STRONG>. On the other hand:
81 <STRONG>o
</STRONG> they do not perform checking (such as for the newline,
82 backspace, or carriage return characters),
84 <STRONG>o
</STRONG> they do not advance the current cursor position,
86 <STRONG>o
</STRONG> they do not expand other control characters to ^-es-
89 <STRONG>o
</STRONG> they truncate the string if it crosses the right mar-
90 gin, rather than wrapping it around to the new line.
94 <H2><a name=
"h2-RETURN-VALUE">RETURN VALUE
</a></H2><PRE>
95 All functions return the integer
<STRONG>ERR
</STRONG> upon failure and
<STRONG>OK
</STRONG>
98 X/Open does not define any error conditions. This imple-
99 mentation returns an error if the window pointer is null.
101 Functions with a
"mv" prefix first perform a cursor move-
102 ment using
<STRONG>wmove
</STRONG>, and return an error if the position is
103 outside the window, or if the window pointer is null.
107 <H2><a name=
"h2-NOTES">NOTES
</a></H2><PRE>
108 All functions except
<STRONG>waddchnstr
</STRONG> may be macros.
112 <H2><a name=
"h2-PORTABILITY">PORTABILITY
</a></H2><PRE>
113 These entry points are described in the XSI Curses stan-
118 <H2><a name=
"h2-SEE-ALSO">SEE ALSO
</a></H2><PRE>
119 <STRONG><A HREF=
"curs_addstr.3x.html">curs_addstr(
3x)
</A></STRONG>,
<STRONG><A HREF=
"ncurses.3x.html">curses(
3x)
</A></STRONG>.
121 Comparable functions in the wide-character (ncursesw) li-
122 brary are described in
<STRONG><A HREF=
"curs_add_wchstr.3x.html">curs_add_wchstr(
3x)
</A></STRONG>.
126 <STRONG><A HREF=
"curs_addchstr.3x.html">curs_addchstr(
3x)
</A></STRONG>
130 <li><a href=
"#h2-NAME">NAME
</a></li>
131 <li><a href=
"#h2-SYNOPSIS">SYNOPSIS
</a></li>
132 <li><a href=
"#h2-DESCRIPTION">DESCRIPTION
</a></li>
133 <li><a href=
"#h2-RETURN-VALUE">RETURN VALUE
</a></li>
134 <li><a href=
"#h2-NOTES">NOTES
</a></li>
135 <li><a href=
"#h2-PORTABILITY">PORTABILITY
</a></li>
136 <li><a href=
"#h2-SEE-ALSO">SEE ALSO
</a></li>