Click above to get retro games delivered to your door ever month!

                                 L_SAVESCR()


Syntax:        L_SAVESCR(<expN1>,<expN2>,<expN3>,<expN4>,
               <expC1>[,<expC2>][,<expN5>])


Purpose:       Allows screens to be saved to a disc file, and then to
               be recalled by using L_RESTSCR().


Arguments:     <expN1>, <expN2> are the row and column co-ordinates of
               the top left hand corner of the area to be saved; (0,0
               to 22,77 valid).

               <expN3>, <expN4> are the row and column co-ordinates of
               the bottom right hand corner of the area to be saved;
               (2,2 to 24,79 valid).

               <expC1> is the name and path of the file to which the
               screen is to saved.

               <expC2> is the optional name that can be assigned to
               the screen; max 10 characters. The default name is
               "default".

               <expN5> is the optional location within the file at
               which to store the screen.


Returns:       A Library error message if the write was not successful
               (see Appendix D) or else a logical (.T.).


Usage:         Up to 99 screens can be saved in a single file. This
               function can be used to reduce the memory overheads of
               having many screens held in RAM.


Examples:      L_SAVESCR(0,0,10,10,"svscr.scr")              && Result: .T.

               L_SAVESCR(0,0,10,10,"svscr.scr","Data_in 1")   && Result: .T.

               L_SAVESCR(0,0,10,10,"svscr.scr","",3)          && Result: .T.

               L_SAVESCR(0,0,10,10,"svscr.scr","Data_in 2",2) && Result: .T.


Notes:         If the file given does not exist, then it will be
               created.  When a screen is being written to file if the
               name and position are not specified, then it will be

               written as the first screen in the file.  It will
               overwrite any screen already in that slot.

               If just a name is specified, then the screen will
               overwrite any existing screen with that name, or will
               be appended to the end of the file if it does not
               already exist.

               If just a position is specified, then the screen will
               be written into that slot in the file.  In this case a
               null string must be passed to the function in the place
               of the screen name. If the position specified is beyond
               the end of the file then the screen will be appended to
               the file.

               If both name and position are specified, then the
               screen will be written into the specified position with
               the specified name. If this position is beyond the end
               of the file, the screen will be appended to the file.
               If a duplicate name is encountered before the specified
               position is reached then the screen will overwrite the
               screen with the duplicate name already on file.


Language:      Clipper