ncurses 5.9 - patch 20120303
[ncurses.git] / man / curs_delch.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_delch.3x,v 1.11 2010/12/04 18:36:44 tom Exp $
30 .TH curs_delch 3X ""
31 .SH NAME
32 \fBdelch\fR,
33 \fBwdelch\fR,
34 \fBmvdelch\fR,
35 \fBmvwdelch\fR \- delete character under the cursor in a \fBcurses\fR window
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fR
38 .sp
39 \fBint delch(void);\fR
40 .br
41 \fBint wdelch(WINDOW *win);\fR
42 .br
43 \fBint mvdelch(int y, int x);\fR
44 .br
45 \fBint mvwdelch(WINDOW *win, int y, int x);\fR
46 .br
47 .SH DESCRIPTION
48 These routines delete the character under the cursor; all characters to the
49 right of the cursor on the same line are moved to the left one position and the
50 last character on the line is filled with a blank.  The cursor position does
51 not change (after moving to \fIy\fR, \fIx\fR, if specified).  (This does not
52 imply use of the hardware delete character feature.)
53 .SH RETURN VALUE
54 All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
55 specifies only "an integer value other than \fBERR\fR") upon successful
56 completion.
57 .PP
58 Functions with a "mv" prefix first perform a cursor movement using
59 \fBwmove\fP, and return an error if the position is outside the window,
60 or if the window pointer is null.
61 .SH NOTES
62 Note that \fBdelch\fR, \fBmvdelch\fR, and \fBmvwdelch\fR may be macros.
63 .SH PORTABILITY
64 These functions are described in the XSI Curses standard, Issue 4.  The
65 standard specifies that they return \fBERR\fR on failure, but specifies no
66 error conditions.
67 .SH SEE ALSO
68 \fBcurses\fR(3X)