xref: /illumos-gate/usr/src/man/man3xcurses/getwin.3xcurses (revision cd61ae21816e53b94bc1673f3f1aa651fc3115e8)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
GETWIN 3XCURSES "Jun 5, 2002"
NAME
getwin, putwin - read a window from, and write a window to, a file
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

WINDOW *getwin(FILE *filep);

int putwin(WINDOW *win, FILE *filep);
DESCRIPTION

The getwin() function reads window-related data (written earlier by putwin()) from the stdio stream pointed to by filep. It then creates and initializes a new window using that data.

The putwin() function writes all the data associated with the window pointed to by win to the stdio stream pointed to by filep. The getwin() function can later retrieve this data.

PARAMETERS
filep

Is a pointer to a stdio stream.

win

Is a pointer to a window.

RETURN VALUES

On success, the getwin() function returns a pointer to the new window created. Otherwise, it returns a null pointer.

On success, the putwin() function returns OK. Otherwise, it returns ERR.

ERRORS

None.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

libcurses(3XCURSES), scr_dump(3XCURSES), attributes(5), standards(5)