


curs_scr_dump(3X)                               curs_scr_dump(3X)


NNAAMMEE
       ccuurrss__ssccrr__dduummpp:  ssccrr__dduummpp, ssccrr__rreessttoorree, ssccrr__iinniitt, ssccrr__sseett -
       read (write) a ccuurrsseess screen from (to) a file

SSYYNNOOPPSSIISS
       ##iinncclluuddee <<ccuurrsseess..hh>>

       iinntt ssccrr__dduummpp((cchhaarr **ccoonnsstt ffiilleennaammee));;
       iinntt ssccrr__rreessttoorree((cchhaarr **ccoonnsstt ffiilleennaammee));;
       iinntt ssccrr__iinniitt((cchhaarr **ccoonnsstt ffiilleennaammee));;
       iinntt ssccrr__sseett((cchhaarr **ccoonnsstt ffiilleennaammee));;

DDEESSCCRRIIPPTTIIOONN
       The ssccrr__dduummpp routine dumps the  current  contents  of  the
       virtual screen to the file _f_i_l_e_n_a_m_e.

       The  ssccrr__rreessttoorree  routine  sets  the virtual screen to the
       contents of _f_i_l_e_n_a_m_e, which must have been  written  using
       ssccrr__dduummpp.   The  next call to ddoouuppddaattee restores the screen
       to the way it looked in the dump file.

       The ssccrr__iinniitt routine reads in the contents of _f_i_l_e_n_a_m_e and
       uses  them  to initialize the ccuurrsseess data structures about
       what the terminal currently has on  its  screen.   If  the
       data  is  determined  to  be  valid, ccuurrsseess bases its next
       update of the  screen  on  this  information  rather  than
       clearing  the  screen and starting from scratch.  ssccrr__iinniitt
       is used after iinniittssccrr or  a  ssyysstteemm  [see  ssyysstteemm(BA_LIB)]
       call  to  share  the screen with another process which has
       done a ssccrr__dduummpp  after  its  eennddwwiinn  call.   The  data  is
       declared  invalid  if  the terminfo capabilities rrmmccuupp and
       nnrrrrmmcc exist; also if the  terminal  has  been  written  to
       since the preceding ssccrr__dduummpp call.

       The  ssccrr__sseett  routine  is a combination of ssccrr__rreessttoorree and
       ssccrr__iinniitt.  It tells the program that  the  information  in
       _f_i_l_e_n_a_m_e is what is currently on the screen, and also what
       the program wants on the screen.  This can be  thought  of
       as a screen inheritance function.

       To  read (write) a window from (to) a file, use the ggeettwwiinn
       and ppuuttwwiinn routines [see ccuurrss__uuttiill(3X)].

RREETTUURRNN VVAALLUUEE
       All routines return the integer EERRRR upon  failure  and  OOKK
       upon success.

NNOOTTEESS
       Note  that  ssccrr__iinniitt,  ssccrr__sseett,  and  ssccrr__rreessttoorree  may  be
       macros.

PPOORRTTAABBIILLIITTYY
       The XSI Curses standard, Issue 4,  describes  these  func-
       tions (adding the const qualifiers).



                                                                1





curs_scr_dump(3X)                               curs_scr_dump(3X)


       The SVr4 docs merely say under ssccrr__iinniitt that the dump data
       is also considered invalid "if the time-stamp of  the  tty
       is old" but don't define "old".

SSEEEE AALLSSOO
       ccuurrsseess(3X),       ccuurrss__iinniittssccrr(3X),      ccuurrss__rreeffrreesshh(3X),
       ccuurrss__uuttiill(3X), ssyysstteemm(3S)


















































                                                                2


