2 ****************************************************************************
3 * Copyright 2019-2022,2023 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 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_insstr.3x,v 1.33 2023/07/01 15:43:20 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
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_insstr 3x 2023-07-01 ncurses 6.4 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">curs_insstr 3x 2023-07-01 ncurses 6.4 Library calls</H1>
44 <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>insstr</STRONG>, <STRONG>insnstr</STRONG>, <STRONG>winsstr</STRONG>, <STRONG>winsnstr</STRONG>, <STRONG>mvinsstr</STRONG>, <STRONG>mvinsnstr</STRONG>, <STRONG>mvwinsstr</STRONG>,
51 <STRONG>mvwinsnstr</STRONG> - insert string before cursor in a <STRONG>curses</STRONG> window
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
56 <STRONG>int</STRONG> <STRONG>insstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
57 <STRONG>int</STRONG> <STRONG>insnstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>winsstr(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
59 <STRONG>int</STRONG> <STRONG>winsnstr(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>
61 <STRONG>int</STRONG> <STRONG>mvinsstr(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>
62 <STRONG>int</STRONG> <STRONG>mvinsnstr(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>
63 <STRONG>int</STRONG> <STRONG>mvwinsstr(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>
64 <STRONG>int</STRONG> <STRONG>mvwinsnstr(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> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 These routines insert a character string (as many characters as will
69 fit on the line) before the character under the cursor. All characters
70 to the right of the cursor are shifted right with the possibility of
71 the rightmost characters on the line being lost. The cursor position
72 does not change (after moving to <EM>y</EM>, <EM>x</EM>, if specified). The functions
73 with <EM>n</EM> as the last argument insert a leading substring of at most <EM>n</EM>
74 characters. If <EM>n</EM><=0, then the entire string is inserted.
76 Special characters are handled as in <STRONG>addch</STRONG>.
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80 All routines that return an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
81 (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful
82 completion, unless otherwise noted in the preceding routine
85 X/Open defines no error conditions. In this implementation, if the
86 window parameter is null or the str parameter is null, an error is
89 Functions with a "mv" prefix first perform a cursor movement using
90 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
91 the window pointer is null.
94 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
95 Note that all but <STRONG>winsnstr</STRONG> may be macros.
98 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
99 These functions are described in the XSI Curses standard, Issue 4,
100 which adds const qualifiers to the arguments.
102 The Single Unix Specification, Version 2 states that <STRONG>insnstr</STRONG> and
103 <STRONG>winsnstr</STRONG> perform wrapping. This is probably an error, since it makes
104 this group of functions inconsistent. Also, no implementation of
105 curses documents this inconsistency.
108 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
109 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>, <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>.
113 ncurses 6.4 2023-07-01 <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
117 <li><a href="#h2-NAME">NAME</a></li>
118 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-NOTES">NOTES</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>