62cb0a49098bcf183f6d9e13c049995ec7ac46ed
[ncurses.git] / doc / html / man / curs_deleteln.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>deleteln</B>,  <B>wdeleteln</B>,  <B>insdelln</B>, <B>winsdelln</B>, <B>insertln</B>, <B>win-</B>
9        <B>sertln</B> - delete and insert lines 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>deleteln(void);</B>
17        <B>int</B> <B>wdeleteln(WINDOW</B> <B>*win);</B>
18        <B>int</B> <B>insdelln(int</B> <B>n);</B>
19        <B>int</B> <B>winsdelln(WINDOW</B> <B>*win,</B> <B>int</B> <B>n);</B>
20        <B>int</B> <B>insertln(void);</B>
21        <B>int</B> <B>winsertln(WINDOW</B> <B>*win);</B>
22
23
24 </PRE>
25 <H2>DESCRIPTION</H2><PRE>
26        The <B>deleteln</B> and <B>wdeleteln</B> routines delete the line  under
27        the cursor in the window; all lines below the current line
28        are moved up one line.  The bottom line of the  window  is
29        cleared.  The cursor position does not change.
30
31        The  <B>insdelln</B>  and  <B>winsdelln</B>  routines,  for  positive <I>n</I>,
32        insert <I>n</I> lines into the specified window above the current
33        line.   The  <I>n</I>  bottom  lines  are  lost.  For negative <I>n</I>,
34        delete <I>n</I> lines (starting with the one under  the  cursor),
35        and  move  the remaining lines up.  The bottom <I>n</I> lines are
36        cleared.  The current cursor position remains the same.
37
38        The <B>insertln</B> and <B>insertln</B> routines, insert  a  blank  line
39        above the current line and the bottom line is lost.
40
41
42 </PRE>
43 <H2>RETURN VALUE</H2><PRE>
44        All routines return the integer <B>ERR</B> upon failure and an <B>OK</B>
45        (SVr4 specifies only "an integer value  other  than  <B>ERR</B>")
46        upon successful completion.
47
48
49 </PRE>
50 <H2>PORTABILITY</H2><PRE>
51        These  functions are described in the XSI Curses standard,
52        Issue 4.  The standard specifies that they return  <B>ERR</B>  on
53        failure, but specifies no error conditions.
54
55
56 </PRE>
57 <H2>NOTES</H2><PRE>
58        Note that all but <B>winsdelln</B> may be macros.
59
60        These  routines  do  not require a hardware line delete or
61        insert feature in the terminal.  In fact, they  won't  use
62        hardware  line  delete/insert  unless <B>idlok(...,</B> <B>TRUE)</B> has
63        been set on the current window.
64
65
66 </PRE>
67 <H2>SEE ALSO</H2><PRE>
68        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>
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>