11f49053095b2ff6a689b1f70af05a0268e418ef
[ncurses.git] / man / curs_insch.3x
1 .TH curs_insch 3X ""
2 .SH NAME
3 \fBinsch\fR, \fBwinsch\fR, \fBmvinsch\fR, \fBmvwinsch\fR -
4 insert a character before cursor in a \fBcurses\fR window
5 .SH SYNOPSIS
6 \fB#include <curses.h>\fR
7
8 \fBint insch(chtype ch);\fR
9 .br
10 \fBint winsch(WINDOW *win, chtype ch);\fR
11 .br
12 \fBint mvinsch(int y, int x, chtype ch);\fR
13 .br
14 \fBint mvwinsch(WINDOW *win, int y, int x, chtype ch);\fR
15 .br
16 .SH DESCRIPTION
17 These routines, insert the character \fIch\fR before the character under the
18 cursor.  All characters to the right of the cursor are moved one space to the
19 right, with the possibility of the rightmost character on the line being lost.
20 The insertion operation does not change the cursor position.
21 .SH RETURN VALUE
22 All routines that return an integer return \fBERR\fR upon failure and OK (SVr4
23 specifies only "an integer value other than \fBERR\fR") upon successful
24 completion, unless otherwise noted in the preceding routine descriptions.
25 .SH NOTES
26 These routines do not necessarily imply use of a hardware insert character
27 feature.
28
29 Note that \fBinsch\fR, \fBmvinsch\fR, and \fBmvwinsch\fR may be macros.
30 .SH PORTABILITY
31 These functions are described in the XSI Curses standard, Issue 4.
32 .SH SEE ALSO
33 \fBcurses\fR(3X).
34 .\"#
35 .\"# The following sets edit modes for GNU EMACS
36 .\"# Local Variables:
37 .\"# mode:nroff
38 .\"# fill-column:79
39 .\"# End: