scr_dump(3xcurses)

1scr_dump(3XCURSES)      X/Open Curses Library Functions     scr_dump(3XCURSES)
2
3
4

NAME

6       scr_dump,  scr_init,  scr_restore,  scr_set  -  write  screen  contents
7       to/from a file
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       int scr_dump(const char *filename);
18
19
20       int scr_init(const char *filename);
21
22
23       int scr_restore(const char *filename);
24
25
26       int scr_set(const char *filename);
27
28

PARAMETERS

30       filename    Is a pointer to the file in which screen contents are writ‐
31                   ten.
32
33

DESCRIPTION

35       These function perform input/output functions on a screen basis.
36
37
38       The  scr_dump()  function  writes  the  contents of the virtual screen,
39       curscr, to filename.
40
41
42       The scr_restore() function reads the contents of filename  from  curscr
43       (which must have been written with scr_dump()).  The next refresh oper‐
44       ation restores the screen to the way it looks in filename.
45
46
47       The scr_init() function reads the contents of filename and  uses  those
48       contents  to  initialize  the  X/Open Curses data structures to what is
49       actually on screen. The next refresh operation  bases  its  updates  on
50       this  data, unless the  terminal has been written to since filename was
51       saved or the  terminfo capabilities rmcup and  nrrmc  are  defined  for
52       the current terminal.
53
54
55       The  scr_set()  function  combines  scr_restore() and  scr_init().   It
56       informs the program that the contents of the file filename are what  is
57       currently  on  the  screen and that the program wants those contents on
58       the screen.
59

RETURN VALUES

61       On success, these functions return OK. Otherwise, they return ERR.
62

ERRORS

64       None.
65

ATTRIBUTES

67       See attributes(5) for descriptions of the following attributes:
68
69
70
71
72       ┌─────────────────────────────┬─────────────────────────────┐
73       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
74       ├─────────────────────────────┼─────────────────────────────┤
75       │Interface Stability          │Standard                     │
76       ├─────────────────────────────┼─────────────────────────────┤
77       │MT-Level                     │Unsafe                       │
78       └─────────────────────────────┴─────────────────────────────┘
79