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

Function:    POPBOX()

Purpose:     Restore a screen from a SAYINBOX() screen variable.

Syntax:      POPBOX( sayinbox_return_string )

Arguments:   The specialized character string that was returned by the
             last call to the SAYINBOX() function.

Returns:     True.

Description: POPBOX() is a companion function to the SAYINBOX() function.
             SAYINBOX() returns a character string which contains not only
             the contents of the displaced screen image, but also the
             coordinates of this screen region displaced by SAYINBOX().
             This character string can be used as a parameter to this
             companion function to restore the screen to the way it was
             before SAYINBOX() was called.  This feature is ideal for
             situations where you want to put up a message box, do some
             processing, then remove the message box while restoring the
             screen to its previous state.

Notes:       The string parameter must be the one returned by SAYINBOX(),
             otherwise unpredictable results may occur.  This is due to
             the fact that SAYINBOX() stores the four screen coordinates
             (top, left, bottom, right) as the first four characters in
             the return string, and POPBOX() uses these coordinates as the
             screen coordinates to issue a RESTSCREEN() function.

Example:     *-- example of an INDEX message
             pbox = SAYINBOX( "BG+/B", "Indexing, please wait" )

             *-- Do the indexing, message will remain
             INDEX ON keyfield TO indexfile

             *-- Remove the message
             POPBOX(pbox)

Source:      RL_SAYIN.PRG

See also:    ABOXASK(), BOXASK(), SAYINBOX()