Index for Section 3

Alphabetical listing for C

Bottom of page

curs_scr_dump(3)
NAME
  curs_scr_dump, scr_dump, scr_init, scr_restore, scr_set - Read or write a
  Curses screen from or to a file

SYNOPSIS
  #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 );

LIBRARY
  Curses Library (libcurses)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  scr_dump, scr_init, scr_restore, scr_set:  XCURSES4.2

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

DESCRIPTION
  The scr_dump routine writes the current contents of the virtual screen to
  filename.

  The scr_restore routine sets the virtual screen to the contents of
  filename, which must have been written using scr_dump. The next call to
  doupdate restores the screen to the way it looked in the dump file.

  The scr_init routine reads the content of filename and uses it to
  initialize the Curses data structures that describe what the terminal
  currently has on its screen. If Curses determines that the data is valid,
  it bases its next update of the screen on this data rather than clearing
  the screen and starting from scratch. Applications call scr_init after an
  initscr or a system call (see system(3)) to share the screen with another
  process that executed scr_dump after endwin. Curses declares the data
  invalid if the time stamp of the tty is old or the terminfo capabilities
  rmcup and nrrmc exist.

  The scr_set routine is a combination of scr_restore and scr_init. This
  routine tells the program that the information in filename is what is
  currently on the screen and is what the program wants on the screen.	The
  scr_set routine can be thought of as a screen-inheritance function.

  To read or write a window from or to a file, use the getwin and putwin
  routines (see curs_util(3)).

NOTES
  The header file <curses.h> automatically includes the header file
  <stdio.h>.

RETURN VALUES
  All routines return the integer ERR upon failure and OK upon success.

SEE ALSO
  Functions: curses(3), curs_initscr(3), curs_refresh(3), curs_util(3),
  system(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page