ncurses 5.1
[ncurses.git] / doc / html / man / curs_delch.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>delch</B>,  <B>wdelch</B>, <B>mvdelch</B>, <B>mvwdelch</B> - delete character under
9        the cursor in a <B>curses</B> window
10
11
12 </PRE>
13 <H2>SYNOPSIS</H2><PRE>
14        <B>#include</B> <B>&lt;curses.h&gt;</B>
15
16        <B>int</B> <B>delch(void);</B>
17        <B>int</B> <B>wdelch(WINDOW</B> <B>*win);</B>
18        <B>int</B> <B>mvdelch(int</B> <B>y,</B> <B>int</B> <B>x);</B>
19        <B>int</B> <B>mvwdelch(WINDOW</B> <B>*win,</B> <B>int</B> <B>y,</B> <B>int</B> <B>x);</B>
20
21
22 </PRE>
23 <H2>DESCRIPTION</H2><PRE>
24        These routines delete the character under the cursor;  all
25        characters to the right of the cursor on the same line are
26        moved to the left one position and the last  character  on
27        the line is filled with a blank.  The cursor position does
28        not change (after moving to <I>y</I>, <I>x</I>,  if  specified).   (This
29        does  not  imply use of the hardware delete character fea-
30        ture.)
31
32
33 </PRE>
34 <H2>RETURN VALUE</H2><PRE>
35        All routines return the integer <B>ERR</B> upon failure and an <B>OK</B>
36        (SVr4  specifies  only  "an integer value other than <B>ERR</B>")
37        upon successful completion.
38
39
40 </PRE>
41 <H2>NOTES</H2><PRE>
42        Note that <B>delch</B>, <B>mvdelch</B>, and <B>mvwdelch</B> may be macros.
43
44
45 </PRE>
46 <H2>PORTABILITY</H2><PRE>
47        These functions are described in the XSI Curses  standard,
48        Issue  4.   The standard specifies that they return <B>ERR</B> on
49        failure, but specifies no error conditions.
50
51
52 </PRE>
53 <H2>SEE ALSO</H2><PRE>
54        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>