Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / 9b9f5e71c18a5d2317f7871a472b47d3d7efc0c4 / . / doc / html / man / curs_addchstr.3x.html
blob: a3441e6c9a1d1184905077499b33cbd37c6003c4 [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]3 * Copyright 2019-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2012,2017 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]30 * @Id: curs_addchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>curs_addchstr 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]42<H1 class="no-header">curs_addchstr 3x 2024-04-20 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]44<STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]49</PRE><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>, <STRONG>mvaddchnstr</STRONG>,
51 <STRONG>mvwaddchstr</STRONG>, <STRONG>mvwaddchnstr</STRONG> - add a <EM>curses</EM> character string to a window
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]57 <STRONG>int</STRONG> <STRONG>addchstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>waddchstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>mvaddchstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>);</STRONG>
60 <STRONG>int</STRONG> <STRONG>mvwaddchstr(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>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>);</STRONG>
61
62 <STRONG>int</STRONG> <STRONG>addchnstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
63 <STRONG>int</STRONG> <STRONG>waddchnstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>mvaddchnstr(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>mvwaddchnstr(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>chtype</STRONG> <STRONG>*</STRONG><EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]66
67
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]68</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
69 These functions copy the (null-terminated) <EM>chstr</EM> array into the window
70 image structure starting at the current cursor position.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]71
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]72 The four functions with <EM>n</EM> as the last argument copy at most <EM>n</EM> elements,
73 but no more than will fit on the line. If <STRONG>n</STRONG>=<STRONG>-1</STRONG> then the whole array is
74 copied, to the maximum number of characters that will fit on the line.
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]75
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]76 The window cursor is <EM>not</EM> advanced. These functions are faster than
77 <STRONG>waddnstr</STRONG>. On the other hand:
78
79 <STRONG>o</STRONG> they do not perform checking (such as for the newline, backspace,
80 or carriage return characters),
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]81
82 <STRONG>o</STRONG> they do not advance the current cursor position,
83
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]84 <STRONG>o</STRONG> they do not expand other control characters to ^-escapes, and
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]85
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]86 <STRONG>o</STRONG> they truncate the string if it crosses the right margin, rather
87 than wrapping it around to the new line.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]88
89
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]90</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
91 All functions return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> on success.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]92
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]93 X/Open Curses does not specify any error conditions. This
94 implementation returns an error
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]95
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]96 <STRONG>o</STRONG> if the <EM>win</EM> parameter is null or
97
98 <STRONG>o</STRONG> if the <EM>wchstr</EM> parameter is null.
99
100 Functions prefixed with "mv" first perform cursor movement and fail if
101 the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]102
103
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]104</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]105 All functions except <STRONG>waddchnstr</STRONG> may be macros.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]106
107
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]108</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
109 These functions are described in X/Open Curses, Issue 4.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]110
111
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]112</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
113 <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM>
114 library in its wide-character configuration (<EM>ncursesw</EM>).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]115
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]116 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>, <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]117
118
119
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]120ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]121</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]122<div class="nav">
123<ul>
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>
131</ul>
132</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]133</BODY>
134</HTML>