html/man/curs_scr_dump.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>curs_scr_dump 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1 class="no-header">curs_scr_dump 3x</H1>
  42 <PRE>
  43 <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>                                     <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
  44
  45
  46
  47
  48 </PRE>
  49 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
  51        <STRONG>curses</STRONG> screen from (to) a file
  52
  53
  54 </PRE>
  55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
  61        <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
  62
  63
  64 </PRE>
  65 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  66        The <STRONG>scr_dump</STRONG> routine dumps the  current  contents  of  the
  67        virtual screen to the file <EM>filename</EM>.
  68
  69        The  <STRONG>scr_restore</STRONG>  routine  sets  the virtual screen to the
  70        contents of <EM>filename</EM>, which must have been  written  using
  71        <STRONG>scr_dump</STRONG>.   The  next call to <STRONG>doupdate</STRONG> restores the screen
  72        to the way it looked in the dump file.
  73
  74        The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and
  75        uses  them  to initialize the <STRONG>curses</STRONG> data structures about
  76        what the terminal currently has on its screen.  If the da-
  77        ta is determined to be valid, <STRONG>curses</STRONG> bases its next update
  78        of the screen on this information rather than clearing the
  79        screen  and starting from scratch.  <STRONG>scr_init</STRONG> is used after
  80        <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> call to share the screen with  another
  81        process  which  has done a <STRONG>scr_dump</STRONG> after its <STRONG>endwin</STRONG> call.
  82        The data is declared invalid if the terminfo  capabilities
  83        <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist; also if the terminal has been writ-
  84        ten to since the preceding <STRONG>scr_dump</STRONG> call.
  85
  86        The <STRONG>scr_set</STRONG> routine is a combination  of  <STRONG>scr_restore</STRONG>  and
  87        <STRONG>scr_init</STRONG>.   It  tells  the program that the information in
  88        <EM>filename</EM> is what is currently on the screen, and also what
  89        the  program  wants on the screen.  This can be thought of
  90        as a screen inheritance function.
  91
  92        To read (write) a window from (to) a file, use the  <STRONG>getwin</STRONG>
  93        and <STRONG>putwin</STRONG> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>].
  94
  95
  96 </PRE>
  97 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  98        All  routines  return  the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
  99        upon success.
 100
 101        X/Open defines no error conditions.  In  this  implementa-
 102        tion,  each  will  return  an  error if the file cannot be
 103        opened.
 104
 105
 106 </PRE>
 107 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 108        Note  that  <STRONG>scr_init</STRONG>,  <STRONG>scr_set</STRONG>,  and  <STRONG>scr_restore</STRONG>  may  be
 109        macros.
 110
 111
 112 </PRE>
 113 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 114        The  XSI  Curses  standard, Issue 4, describes these func-
 115        tions (adding the const qualifiers).
 116
 117        The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data
 118        is  also  considered invalid "if the time-stamp of the tty
 119        is old" but do not define "old".
 120
 121
 122 </PRE>
 123 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 124        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,      <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,       <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
 125        <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>system(3)</STRONG>
 126
 127
 128
 129                                                       <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
 130 </PRE>
 131 <div class="nav">
 132 <ul>
 133 <li><a href="#h2-NAME">NAME</a></li>
 134 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 135 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 136 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 137 <li><a href="#h2-NOTES">NOTES</a></li>
 138 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 139 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 140 </ul>
 141 </div>
 142 </BODY>
 143 </HTML>