usr/src/man/man3xcurses/delwin.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 DELWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 delwin \- delete 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 \fBdelwin\fR(\fBWINDOW *\fR\fIwin\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBdelwin()\fR function deletes the specified window, freeing up the memory
  26 associated with it.
  27 .sp
  28 .LP
  29 Deleting a parent window without deleting its subwindows and then trying to
  30 manipulate the subwindows will have undefined results.
  31 .SH PARAMETERS
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIwin\fR\fR
  36 .ad
  37 .RS 7n
  38 Is a pointer to the window that is to be deleted.
  39 .RE
  40
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 On success, this functions returns \fBOK\fR. Otherwise, it returns \fBERR\fR.
  45 .SH ERRORS
  46 .sp
  47 .LP
  48 None.
  49 .SH ATTRIBUTES
  50 .sp
  51 .LP
  52 See \fBattributes\fR(5) for descriptions of the following attributes:
  53 .sp
  54
  55 .sp
  56 .TS
  57 box;
  58 c | c
  59 l | l .
  60 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  61 _
  62 Interface Stability     Standard
  63 _
  64 MT-Level        Unsafe
  65 .TE
  66
  67 .SH SEE ALSO
  68 .sp
  69 .LP
  70 \fBderwin\fR(3XCURSES), \fBdupwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  71 \fBattributes\fR(5), \fBstandards\fR(5)