xref: /minix3/lib/libcurses/curses_delch.3 (revision 51ffecc181005cb45a40108612ee28d1daaeeb86)
1*51ffecc1SBen Gras.\"	$NetBSD: curses_delch.3,v 1.3 2003/04/16 13:35:01 wiz Exp $
2*51ffecc1SBen Gras.\"
3*51ffecc1SBen Gras.\" Copyright (c) 2002
4*51ffecc1SBen Gras.\"	Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
5*51ffecc1SBen Gras.\"
6*51ffecc1SBen Gras.\" This code is donated to the NetBSD Foundation by the Author.
7*51ffecc1SBen Gras.\"
8*51ffecc1SBen Gras.\" Redistribution and use in source and binary forms, with or without
9*51ffecc1SBen Gras.\" modification, are permitted provided that the following conditions
10*51ffecc1SBen Gras.\" are met:
11*51ffecc1SBen Gras.\" 1. Redistributions of source code must retain the above copyright
12*51ffecc1SBen Gras.\"    notice, this list of conditions and the following disclaimer.
13*51ffecc1SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
14*51ffecc1SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
15*51ffecc1SBen Gras.\"    documentation and/or other materials provided with the distribution.
16*51ffecc1SBen Gras.\" 3. The name of the Author may not be used to endorse or promote
17*51ffecc1SBen Gras.\"    products derived from this software without specific prior written
18*51ffecc1SBen Gras.\"    permission.
19*51ffecc1SBen Gras.\"
20*51ffecc1SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
21*51ffecc1SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22*51ffecc1SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23*51ffecc1SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
24*51ffecc1SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25*51ffecc1SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26*51ffecc1SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27*51ffecc1SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28*51ffecc1SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29*51ffecc1SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30*51ffecc1SBen Gras.\" SUCH DAMAGE.
31*51ffecc1SBen Gras.\"
32*51ffecc1SBen Gras.\"
33*51ffecc1SBen Gras.Dd August 12, 2002
34*51ffecc1SBen Gras.Dt CURSES_DELCH 3
35*51ffecc1SBen Gras.Os
36*51ffecc1SBen Gras.Sh NAME
37*51ffecc1SBen Gras.Nm curses_delch ,
38*51ffecc1SBen Gras.Nm delch ,
39*51ffecc1SBen Gras.Nm wdelch
40*51ffecc1SBen Gras.Nd curses delete characters routines
41*51ffecc1SBen Gras.Sh LIBRARY
42*51ffecc1SBen Gras.Lb libcurses
43*51ffecc1SBen Gras.Sh SYNOPSIS
44*51ffecc1SBen Gras.In curses.h
45*51ffecc1SBen Gras.Ft int
46*51ffecc1SBen Gras.Fn delch "void"
47*51ffecc1SBen Gras.Ft int
48*51ffecc1SBen Gras.Fn wdelch "WINDOW *win"
49*51ffecc1SBen Gras.Sh DESCRIPTION
50*51ffecc1SBen GrasThese functions delete characters from
51*51ffecc1SBen Gras.Dv stdscr
52*51ffecc1SBen Grasor from the specified window.
53*51ffecc1SBen Gras.Pp
54*51ffecc1SBen GrasThe
55*51ffecc1SBen Gras.Fn delch
56*51ffecc1SBen Grasfunction deletes the character at the current cursor position on
57*51ffecc1SBen Gras.Dv stdscr .
58*51ffecc1SBen GrasCharacters to the right of the deleted character are moved one position
59*51ffecc1SBen Grasto the left.
60*51ffecc1SBen GrasThe cursor position is unchanged.
61*51ffecc1SBen Gras.Pp
62*51ffecc1SBen GrasThe
63*51ffecc1SBen Gras.Fn wdelch
64*51ffecc1SBen Grasfunction is the same as the
65*51ffecc1SBen Gras.Fn delch
66*51ffecc1SBen Grasfunction, excepting that the character is deleted from the specified window.
67*51ffecc1SBen Gras.Sh RETURN VALUES
68*51ffecc1SBen GrasFunctions returning pointers will return
69*51ffecc1SBen Gras.Dv NULL
70*51ffecc1SBen Grasif an error is detected.
71*51ffecc1SBen GrasThe functions that return an int will return one of the following
72*51ffecc1SBen Grasvalues:
73*51ffecc1SBen Gras.Pp
74*51ffecc1SBen Gras.Bl -tag -width ERR -compact
75*51ffecc1SBen Gras.It Er OK
76*51ffecc1SBen GrasThe function completed successfully.
77*51ffecc1SBen Gras.It Er ERR
78*51ffecc1SBen GrasAn error occurred in the function.
79*51ffecc1SBen Gras.El
80*51ffecc1SBen Gras.Sh SEE ALSO
81*51ffecc1SBen Gras.Xr curses_addch 3 ,
82*51ffecc1SBen Gras.Xr curses_insertch 3
83*51ffecc1SBen Gras.Sh STANDARDS
84*51ffecc1SBen GrasThe
85*51ffecc1SBen Gras.Nx
86*51ffecc1SBen GrasCurses library complies with the X/Open Curses specification, part of the
87*51ffecc1SBen GrasSingle Unix Specification.
88*51ffecc1SBen Gras.Sh HISTORY
89*51ffecc1SBen GrasThe Curses package appeared in
90*51ffecc1SBen Gras.Bx 4.0 .
91