ncurses 5.9 - patch 20130608
[ncurses.git] / doc / html / man / curs_insch.3x.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 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.13 2010/12/04 18:38:55 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_insch 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_insch 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>                                           <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>insch</STRONG>,  <STRONG>winsch</STRONG>,  <STRONG>mvinsch</STRONG>,  <STRONG>mvwinsch</STRONG>  -  insert a character
51        before cursor in a <STRONG>curses</STRONG> window
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>int</STRONG> <STRONG>insch(chtype</STRONG> <STRONG>ch);</STRONG>
59        <STRONG>int</STRONG> <STRONG>winsch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
60        <STRONG>int</STRONG> <STRONG>mvinsch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
61        <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>
62
63
64 </PRE>
65 <H2>DESCRIPTION</H2><PRE>
66        These routines insert the character <EM>ch</EM> before the  charac-
67        ter  under the cursor.  All characters to the right of the
68        cursor are moved one space to the right, with  the  possi-
69        bility  of the rightmost character on the line being lost.
70        The insertion operation does not change the  cursor  posi-
71        tion.
72
73
74 </PRE>
75 <H2>RETURN VALUE</H2><PRE>
76        All  routines that return an integer return <STRONG>ERR</STRONG> upon fail-
77        ure and OK (SVr4 specifies only "an  integer  value  other
78        than  <STRONG>ERR</STRONG>")  upon  successful completion, unless otherwise
79        noted in the preceding routine descriptions.
80
81        Functions with a "mv" prefix first perform a cursor  move-
82        ment  using  <STRONG>wmove</STRONG>, and return an error if the position is
83        outside the window, or if the window pointer is null.
84
85
86 </PRE>
87 <H2>NOTES</H2><PRE>
88        These routines do not necessarily imply use of a  hardware
89        insert character feature.
90
91        Note that <STRONG>insch</STRONG>, <STRONG>mvinsch</STRONG>, and <STRONG>mvwinsch</STRONG> may be macros.
92
93
94 </PRE>
95 <H2>PORTABILITY</H2><PRE>
96        These  functions are described in the XSI Curses standard,
97        Issue 4.
98
99
100 </PRE>
101 <H2>SEE ALSO</H2><PRE>
102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
103
104        Comparable  functions  in  the  wide-character  (ncursesw)
105        library are described in <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>.
106
107
108
109                                                          <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
110 </PRE>
111 <HR>
112 <ADDRESS>
113 Man(1) output converted with
114 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
115 </ADDRESS>
116 </BODY>
117 </HTML>