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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, 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 ENDWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 endwin, isendwin \- restore initial terminal environment
   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 \fBendwin\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBbool\fR \fBisendwin\fR(\fBvoid\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBendwin()\fR function restores the terminal after Curses activity by at
  31 least restoring the saved shell terminsl mode, flushing any output to the
  32 terminal, and  moving the cursor to the first column of the last line of the
  33 screen. Refreshing a window resumes program mode. The application must call
  34 \fBendwin()\fR for each terminal being used before exiting. If
  35 \fBnewterm\fR(3XCURSES) is called more than once for the same terminal, the
  36 first screen created must be the last one for which \fBendwin()\fR is called.
  37 .sp
  38 .LP
  39 The \fBisendiwin()\fR function indicates whether or not a screen has been
  40 refreshed since the last call to \fBendwin()\fR.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 Upon successful completion, the \fBendwin()\fR function returns \fBOK\fR.
  45 Otherwise, it returns \fBERR\fR.
  46 .sp
  47 .LP
  48 The \fBisendwin()\fR function returns \fBTRUE\fR if \fBendwin()\fR has been
  49 called without any subsequent refresh. Otherwise, it returns \fBFALSE\fR.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 Non errors are defined.
  54 .SH ATTRIBUTES
  55 .sp
  56 .LP
  57 See \fBattributes\fR(5) for descriptions of the following attributes:
  58 .sp
  59
  60 .sp
  61 .TS
  62 box;
  63 c | c
  64 l | l .
  65 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  66 _
  67 Interface Stability     Standard
  68 _
  69 MT-Level        Unsafe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES),
  76 \fBattributes\fR(5), \fBstandards\fR(5)