ncurses 4.1
[ncurses.git] / man / curs_delch.3x
1 .TH curs_delch 3X ""
2 .SH NAME
3 \fBdelch\fR, \fBwdelch\fR, \fBmvdelch\fR, \fBmvwdelch\fR -
4 delete character under the cursor in a \fBcurses\fR window
5 .SH SYNOPSIS
6 \fB#include <curses.h>\fR
7
8 \fBint delch(void);\fR
9 .br
10 \fBint wdelch(WINDOW *win);\fR
11 .br
12 \fBint mvdelch(int y, int x);\fR
13 .br
14 \fBint mvwdelch(WINDOW *win, int y, int x);\fR
15 .br
16 .SH DESCRIPTION
17 These routines delete the character under the cursor; all characters to the
18 right of the cursor on the same line are moved to the left one position and the
19 last character on the line is filled with a blank.  The cursor position does
20 not change (after moving to \fIy\fR, \fIx\fR, if specified).  (This does not
21 imply use of the hardware delete character feature.)
22 .SH RETURN VALUE
23 All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
24 specifies only "an integer value other than \fBERR\fR") upon successful
25 completion.
26 .SH NOTES
27 Note that \fBdelch\fR, \fBmvdelch\fR, and \fBmvwdelch\fR may be macros.
28 .SH PORTABILITY
29 These functions are described in the XSI Curses standard, Issue 4.  The
30 standard specifies that they return \fBERR\fR on failure, but specifies no
31 error conditions.
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: