usr/src/man/man3xcurses/getwin.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 GETWIN 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 getwin, putwin \- read a window from, and write a window to, a file
   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 \fBWINDOW *\fR\fBgetwin\fR(\fBFILE *\fR\fIfilep\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBputwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBFILE *\fR\fIfilep\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBgetwin()\fR function reads window-related data (written earlier by
  31 \fBputwin()\fR) from the \fBstdio\fR stream pointed to by \fIfilep\fR. It then
  32 creates and initializes a new window using that data.
  33 .sp
  34 .LP
  35 The \fBputwin()\fR function writes all the data associated with the window
  36 pointed to by \fIwin\fR to the \fBstdio\fR stream pointed to by \fIfilep\fR.
  37 The \fBgetwin()\fR function can later retrieve this data.
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIfilep\fR\fR
  43 .ad
  44 .RS 9n
  45 Is a pointer to a \fBstdio\fR stream.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIwin\fR\fR
  52 .ad
  53 .RS 9n
  54 Is a pointer to a window.
  55 .RE
  56
  57 .SH RETURN VALUES
  58 .sp
  59 .LP
  60 On success, the \fBgetwin()\fR function returns a pointer to the new window
  61 created. Otherwise, it returns a null pointer.
  62 .sp
  63 .LP
  64 On success, the \fBputwin()\fR function returns \fBOK\fR. Otherwise, it returns
  65 \fBERR\fR.
  66 .SH ERRORS
  67 .sp
  68 .LP
  69 None.
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Standard
  84 _
  85 MT-Level        Unsafe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBlibcurses\fR(3XCURSES), \fBscr_dump\fR(3XCURSES), \fBattributes\fR(5),
  92 \fBstandards\fR(5)