scr_restore Subroutine

Purpose

Restores the virtual screen from a dump file.

Library

Curses Library (libcurses.a)

Syntax

#include <curses.h>

scr_restore( FileName)
char *FileName;

Description

The scr_restore subroutine restores the virtual screen from the contents of a dump file. You create a dump file with the scr_dump subroutine. To update the terminal's display with the restored virtual screen, call the wrefresh or doupdate subroutine after restoring from a dump file.

To communicate the screen image across processes, use the scr_restore subroutine along with the scr_dump subroutine.

Return Values

Item Description
ERR Indicates the content of the dump file is incompatible with the current release of curses.
OK Indicates that the virtual screen was successfully restored from a dump file.

Parameters

Item Description
FileName Identifies the name of the dump file.

Example

To restore the contents of the virtual screen from the /tmp/virtual.dump file and update the terminal screen, use:

scr_restore("/tmp/virtual.dump");
doupdate();