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