| 1 |
<!-- |
| 2 |
**************************************************************************** |
| 3 |
* Copyright 2019-2024,2025 Thomas E. Dickey * |
| 4 |
* Copyright 1998-2012,2017 Free Software Foundation, Inc. * |
| 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 |
**************************************************************************** |
| 30 |
* @Id: curs_addchstr.3x,v 1.64 2025/08/16 19:56:13 tom Exp @ |
| 31 |
--> |
| 32 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 33 |
<HTML> |
| 34 |
<HEAD> |
| 35 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 36 |
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> |
| 37 |
<TITLE>curs_addchstr 3x 2025-08-16 ncurses 6.6 Library calls</TITLE> |
| 38 |
<link rel="author" href="mailto:[email protected]"> |
| 39 |
|
| 40 |
</HEAD> |
| 41 |
<BODY> |
| 42 |
<H1 class="no-header">curs_addchstr 3x 2025-08-16 ncurses 6.6 Library calls</H1> |
| 43 |
<PRE> |
| 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> |
| 45 |
|
| 46 |
|
| 47 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 48 |
<STRONG>addchstr</STRONG>, <STRONG>waddchstr</STRONG>, <STRONG>mvaddchstr</STRONG>, <STRONG>mvwaddchstr</STRONG>, <STRONG>addchnstr</STRONG>, <STRONG>waddchnstr</STRONG>, |
| 49 |
<STRONG>mvaddchnstr</STRONG>, <STRONG>mvwaddchnstr</STRONG> - add a <EM>curses</EM> character string to a window |
| 50 |
|
| 51 |
|
| 52 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 53 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 54 |
|
| 55 |
<STRONG>int</STRONG> <STRONG>addchstr(const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG> |
| 56 |
<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> |
| 57 |
<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> |
| 58 |
<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> |
| 59 |
<STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>);</STRONG> |
| 60 |
|
| 61 |
<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> |
| 62 |
<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> |
| 63 |
<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> |
| 64 |
<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> |
| 65 |
<STRONG>const</STRONG> <STRONG>chtype</STRONG> <STRONG>*</STRONG> <EM>chstr</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> |
| 66 |
|
| 67 |
|
| 68 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 69 |
<STRONG>waddchstr</STRONG> copies the string of <EM>curses</EM> characters <EM>chstr</EM> to the window |
| 70 |
<EM>win</EM>. A null <EM>curses</EM> character terminates the string. <STRONG>waddchnstr</STRONG> does |
| 71 |
the same, but copies at most <EM>n</EM> characters, or as many as possible if <EM>n</EM> |
| 72 |
is <STRONG>-1</STRONG>. <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> describes the variants of these functions. |
| 73 |
|
| 74 |
Because these functions do not call <STRONG><A HREF="curs_addch.3x.html">waddch(3x)</A></STRONG> internally, they are |
| 75 |
faster than <STRONG><A HREF="curs_addstr.3x.html">waddstr(3x)</A></STRONG> and <STRONG><A HREF="curs_addstr.3x.html">waddnstr(3x)</A></STRONG>. On the other hand, they |
| 76 |
|
| 77 |
<STRONG>o</STRONG> do not treat the backspace, carriage return, or line feed |
| 78 |
characters specially; |
| 79 |
|
| 80 |
<STRONG>o</STRONG> do not represent unprintable characters with <STRONG><A HREF="unctrl.3x.html">unctrl(3x)</A></STRONG>; |
| 81 |
|
| 82 |
<STRONG>o</STRONG> do not update the cursor position to follow the last character |
| 83 |
written; and |
| 84 |
|
| 85 |
<STRONG>o</STRONG> truncate the string at the window's right margin, rather than |
| 86 |
wrapping it to the next line and potentially scrolling. |
| 87 |
|
| 88 |
|
| 89 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 90 |
These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure. |
| 91 |
|
| 92 |
In <EM>ncurses</EM>, these functions fail if |
| 93 |
|
| 94 |
<STRONG>o</STRONG> the <EM>curses</EM> screen has not been initialized, |
| 95 |
|
| 96 |
<STRONG>o</STRONG> <EM>chstr</EM> is a null pointer, or |
| 97 |
|
| 98 |
<STRONG>o</STRONG> (for functions taking a <EM>WINDOW</EM> pointer argument) <EM>win</EM> is a null |
| 99 |
pointer. |
| 100 |
|
| 101 |
Functions prefixed with "mv" first perform cursor movement and fail if |
| 102 |
the position (<EM>y</EM>, <EM>x</EM>) is outside the window boundaries. |
| 103 |
|
| 104 |
|
| 105 |
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> |
| 106 |
All of these functions except <STRONG>waddchnstr</STRONG> may be implemented as macros. |
| 107 |
|
| 108 |
|
| 109 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 110 |
X/Open Curses Issue 4 describes these functions. It specifies no error |
| 111 |
conditions for them. |
| 112 |
|
| 113 |
SVr4 describes a successful return value only as "an integer value |
| 114 |
other than <EM>ERR</EM>". |
| 115 |
|
| 116 |
|
| 117 |
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> |
| 118 |
SVr3.1 (1987) introduced these functions. |
| 119 |
|
| 120 |
|
| 121 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 122 |
<STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG> describes comparable functions of the <EM>ncurses</EM> |
| 123 |
library in its wide-character configuration (<EM>ncursesw</EM>). |
| 124 |
|
| 125 |
<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> |
| 126 |
|
| 127 |
ncurses 6.6 2025-08-16 <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG> |
| 128 |
</PRE> |
| 129 |
<div class="nav"> |
| 130 |
<ul> |
| 131 |
<li><a href="#h2-NAME">NAME</a></li> |
| 132 |
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> |
| 133 |
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> |
| 134 |
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> |
| 135 |
<li><a href="#h2-NOTES">NOTES</a></li> |
| 136 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 137 |
<li><a href="#h2-HISTORY">HISTORY</a></li> |
| 138 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 139 |
</ul> |
| 140 |
</div> |
| 141 |
</BODY> |
| 142 |
</HTML> |