Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_addchstr.3x.html
blob: ce3cd02f1363b41c7f1820721cf902d419fb55f2 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]3 * Copyright (c) 1998-2010,2012 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]4 * *
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: *
12 * *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
15 * *
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. *
23 * *
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 *
27 * authorization. *
28 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]29 * @Id: curs_addchstr.3x,v 1.16 2012/11/03 22:54:43 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]41<H1 class="no-header">curs_addchstr 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]67
68
69</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]77
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]78 The window cursor is <EM>not</EM> advanced. These functions work
79 faster than <STRONG>waddnstr</STRONG>. On the other hand:
80
81 <STRONG>o</STRONG> they do not perform checking (such as for the newline,
82 backspace, or carriage return characters),
83
84 <STRONG>o</STRONG> they do not advance the current cursor position,
85
86 <STRONG>o</STRONG> they do not expand other control characters to ^-es-
87 capes, and
88
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.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]91
92
93</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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>
96 on success.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]97
98 X/Open does not define any error conditions. This imple-
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]99 mentation returns an error if the window pointer is null.
100
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.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]104
105
106</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]107<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108 All functions except <STRONG>waddchnstr</STRONG> may be macros.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]109
110
111</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]112<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113 These entry points are described in the XSI Curses stan-
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]114 dard, Issue 4.
115
116
117</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]120
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]121 Comparable functions in the wide-character (ncursesw) li-
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]122 brary are described in <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>.
123
124
125
126 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
127</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]128<div class="nav">
129<ul>
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>
137</ul>
138</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]139</BODY>
140</HTML>