Copyright (c) 2002
Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
This code is donated to the NetBSD Foundation by the Author.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the Author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd August 12, 2002 .Dt CURSES_DELETELN 3 .Os .Sh NAME .Nm curses_deleteln , .Nm deleteln , .Nm wdeleteln .Nd curses delete single line routines .Sh LIBRARY .Lb libcurses .Sh SYNOPSIS n curses.h .Ft int .Fn deleteln "void" .Ft int .Fn wdeleteln "WINDOW *win" .Sh DESCRIPTION These functions delete a single line from .Dv stdscr or from the specified window.
p The .Fn deleteln function deletes the screen line containing the cursor in the .Dv stdscr . The .Fn wdeleteln function is the same as the .Fn deleteln function, excepting that the line is deleted from the window specified by .Fa win .
p All lines following the deleted line are moved up one line toward the cursor. The last line of the window is cleared. The cursor position is unchanged.
p If a scrolling region has been set with the .Fn setscrreg or .Fn wsetscrreg functions and the current cursor position is inside the scrolling region, then only the lines from the current line to the bottom of the scrolling region are moved up and the bottom line of the scrolling region cleared.
p The functions .Fn deleteln and .Fn wdeleteln win are equivalent to .Fn winsdelln stdscr -1 and .Fn winsdelln win -1 respectively. .Sh RETURN VALUES Functions returning pointers will return .Dv NULL if an error is detected. The functions that return an int will return one of the following values:
p l -tag -width ERR -compact t Er OK The function completed successfully. t Er ERR An error occurred in the function. .El .Sh SEE ALSO .Xr curses_insdelln 3 , .Xr curses_insertln 3 , .Xr curses_scroll 3 .Sh STANDARDS The .Nx Curses library complies with the X/Open Curses specification, part of the Single Unix Specification. .Sh HISTORY The Curses package appeared in x 4.0 .