xref: /titanic_51/usr/src/man/man3xcurses/scr_dump.3xcurses (revision 0d928757379972073af9fb22bdc827b74e8ba6ac)
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]
SCR_DUMP 3XCURSES "Jun 5, 2002"
NAME
scr_dump, scr_init, scr_restore, scr_set - write screen contents to/from 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>

int scr_dump(const char *filename);

int scr_init(const char *filename);

int scr_restore(const char *filename);

int scr_set(const char *filename);
PARAMETERS
filename

Is a pointer to the file in which screen contents are written.

DESCRIPTION

These function perform input/output functions on a screen basis.

The scr_dump() function writes the contents of the virtual screen, curscr, to filename.

The scr_restore() function reads the contents of filename from curscr (which must have been written with scr_dump()). The next refresh operation restores the screen to the way it looks in filename.

The scr_init() function reads the contents of filename and uses those contents to initialize the X/Open Curses data structures to what is actually on screen. The next refresh operation bases its updates on this data, unless the terminal has been written to since filename was saved or the terminfo capabilities rmcup and nrrmc are defined for the current terminal.

The scr_set() function combines scr_restore() and scr_init(). It informs the program that the contents of the file filename are what is currently on the screen and that the program wants those contents on the screen.

RETURN VALUES

On success, these functions return OK. Otherwise, they return 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

delscreen(3XCURSES), doupdate(3XCURSES), endwin(3XCURSES), getwin(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)