curs_scr_dmp(3X) curs_scr_dmp(3X)
NAME
cursscrdump: scrdump, scrrestore, scrinit, scrset -
read (write) a curses screen from (to) a file
SYNOPSIS
#include <curses.h>
int scrdump(char *filename);
int scrrestore(char *filename);
int scrinit(char *filename);
int scrset(char *filename);
DESCRIPTION
With the scrdump routine, the current contents of the vir-
tual screen are written to the file filename.
With the scrrestore routine, the virtual screen is set to
the contents of filename, which must have been written using
scrdump. The next call to doupdate restores the screen to
the way it looked in the dump file.
With the scrinit routine, the contents of filename are read
in and used to initialize the curses data structures about
what the terminal currently has on its screen. If the data
is determined to be valid, curses bases its next update of
the screen on this information rather than clearing the
screen and starting from scratch. scrinit is used after
initscr or a system [see system(BA_LIB)] call to share the
screen with another process which has done a scrdump after
its endwin call. The data is declared invalid if the time-
stamp of the tty is old or the terminfo capabilities rmcup
and nrrmc exist.
The scrset routine is a combination of scrrestore and
scrinit. It tells the program that the information in
filename is what is currently on the screen, and also what
the program wants on the screen. This can be thought of as
a screen inheritance function.
To read (write) a window from (to) a file, use the getwin
and putwin routines [see cursutil(3X)].
RETURN VALUE
All routines return the integer ERR upon failure and OK upon
success.
NOTES
The header file <curses.h> automatically includes the header
files <stdio.h> and <unctrl.h>.
Note that scrinit, scrset, and scrrestore may be macros.
Page 1 CX/UX Programmer's Reference Manual
curs_scr_dmp(3X) curs_scr_dmp(3X)
SEE ALSO
curses(3X), cursinitscr(3X), cursrefresh(3X),
cursutil(3X), system(3S).
Page 2 CX/UX Programmer's Reference Manual