usr/src/man/man3xcurses/clrtobot.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 CLRTOBOT 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 clrtobot, wclrtobot \- clear to the end of 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 \fBclrtobot\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBwclrtobot\fR(\fBWINDOW *\fR\fIwin\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBclrtobot()\fR function clears all characters in the \fBstdscr\fR  window
  31 from the cursor to the end of the window. The \fBwclrtobot()\fR function
  32 performs the same action in the window  specified by \fIwin\fR instead of in
  33 \fBstdscr\fR. The current background character (and rendition) is used to clear
  34 the screen.
  35 .sp
  36 .LP
  37 If the clearing action results in clearing only a portion of a multicolumn
  38 character, background characters are displayed in place of the  remaining
  39 portion.
  40 .SH PARAMETERS
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIwin\fR\fR
  45 .ad
  46 .RS 7n
  47 Is a pointer to the window that is to be cleared.
  48 .RE
  49
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  54 .SH ERRORS
  55 .sp
  56 .LP
  57 None.
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 Interface Stability     Standard
  72 _
  73 MT-Level        Unsafe
  74 .TE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBbkgdset\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclearok\fR(3XCURSES),
  80 \fBclrtoeol\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
  81 \fBstandards\fR(5)