ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_insch.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 1998-2010,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_insch.3x,v 1.17 2020/02/02 23:34:34 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_insch 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_insch 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>                                                  <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>insch</STRONG>,  <STRONG>winsch</STRONG>, <STRONG>mvinsch</STRONG>, <STRONG>mvwinsch</STRONG> - insert a character before cursor in
51        a <STRONG>curses</STRONG> window
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>insch(chtype</STRONG> <STRONG>ch);</STRONG>
58        <STRONG>int</STRONG> <STRONG>winsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
59        <STRONG>int</STRONG> <STRONG>mvinsch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
60        <STRONG>int</STRONG> <STRONG>mvwinsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        These routines insert the character <EM>ch</EM> before the character  under  the
65        cursor.   All characters to the right of the cursor are moved one space
66        to the right, with the possibility of the rightmost  character  on  the
67        line  being  lost.   The insertion operation does not change the cursor
68        position.
69
70
71 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
72        All routines that return an integer return  <STRONG>ERR</STRONG>  upon  failure  and  <STRONG>OK</STRONG>
73        (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>") upon successful
74        completion, unless otherwise noted in the  preceding  routine  descrip-
75        tions.
76
77        Functions  with  a  "mv"  prefix  first perform a cursor movement using
78        <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
79        the window pointer is null.
80
81
82 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
83        These  routines do not necessarily imply use of a hardware insert char-
84        acter feature.
85
86        Note that <STRONG>insch</STRONG>, <STRONG>mvinsch</STRONG>, and <STRONG>mvwinsch</STRONG> may be macros.
87
88
89 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
90        These functions are described in the XSI Curses standard, Issue 4.
91
92
93 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
94        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
95
96        Comparable functions  in  the  wide-character  (ncursesw)  library  are
97        described in <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>.
98
99
100
101                                                                 <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
102 </PRE>
103 <div class="nav">
104 <ul>
105 <li><a href="#h2-NAME">NAME</a></li>
106 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
107 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
108 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
109 <li><a href="#h2-NOTES">NOTES</a></li>
110 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
111 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
112 </ul>
113 </div>
114 </BODY>
115 </HTML>