usr/src/man/man3xcurses/insertln.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH INSERTLN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 insertln, winsertln \- insert a line in a window
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBinsertln\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBwinsertln\fR(\fBWINDOW *\fR\fIwin\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIwin\fR\fR
  32 .ad
  33 .RS 7n
  34 Is a pointer to the window in which to insert the line.
  35 .RE
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBinsertln()\fR and \fBwinsertln()\fR functions insert a blank line before
  41 the current line in \fBstdscr\fR or \fIwin\fR, respectively.  The new line
  42 becomes the current line.   The current line and all lines after it in the
  43 window are moved down one line.  The bottom line in the window is discarded.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 None.
  52 .SH ATTRIBUTES
  53 .sp
  54 .LP
  55 See \fBattributes\fR(5) for descriptions of the following attributes:
  56 .sp
  57
  58 .sp
  59 .TS
  60 box;
  61 c | c
  62 l | l .
  63 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  64 _
  65 Interface Stability     Standard
  66 _
  67 MT-Level        Unsafe
  68 .TE
  69
  70 .SH SEE ALSO
  71 .sp
  72 .LP
  73 \fBbkgdset\fR(3XCURSES), \fBdeleteln\fR(3XCURSES), \fBinsdelln\fR(3XCURSES),
  74 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)