ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / curs_delch.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
4   * Copyright 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_delch.3x,v 1.14 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_delch 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_delch 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>                                                  <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>delch</STRONG>, <STRONG>wdelch</STRONG>, <STRONG>mvdelch</STRONG>, <STRONG>mvwdelch</STRONG> - delete character under the 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>delch(void);</STRONG>
58        <STRONG>int</STRONG> <STRONG>wdelch(WINDOW</STRONG> <STRONG>*win);</STRONG>
59        <STRONG>int</STRONG> <STRONG>mvdelch(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
60        <STRONG>int</STRONG> <STRONG>mvwdelch(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        These routines delete the character under the cursor; all characters to
65        the  right  of  the  cursor  on the same line are moved to the left one
66        position and the last character on the line is  filled  with  a  blank.
67        The  cursor  position  does not change (after moving to <EM>y</EM>, <EM>x</EM>, if speci-
68        fied).  (This does not imply use of the hardware delete character  fea-
69        ture.)
70
71
72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
73        All routines return the integer <STRONG>ERR</STRONG> upon failure and an <STRONG>OK</STRONG> (SVr4 speci-
74        fies only "an integer value other than <STRONG>ERR</STRONG>")  upon  successful  comple-
75        tion.
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        Note that <STRONG>delch</STRONG>, <STRONG>mvdelch</STRONG>, and <STRONG>mvwdelch</STRONG> may be macros.
84
85
86 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
87        These functions are described in the XSI Curses standard, Issue 4.  The
88        standard specifies that they return <STRONG>ERR</STRONG> on failure,  but  specifies  no
89        error conditions.
90
91
92 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
93        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
94
95
96
97                                                                 <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
98 </PRE>
99 <div class="nav">
100 <ul>
101 <li><a href="#h2-NAME">NAME</a></li>
102 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
103 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
104 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
105 <li><a href="#h2-NOTES">NOTES</a></li>
106 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
107 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
108 </ul>
109 </div>
110 </BODY>
111 </HTML>