opensolaris man page for scr_set

scr_dump(3XCURSES)					  X/Open Curses Library Functions					scr_dump(3XCURSES)

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 
	-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)

SunOS 5.11							    5 Jun 2002							scr_dump(3XCURSES)