# __XRestScreen()

Restore screen image and coordinate from an internal buffer

Syntax

  __XRestScreen() --> NIL

Arguments

  none.

Returns

  __XRestScreen() always return NIL.

Description

  __XRestScreen() restore saved image of the whole screen from an internal buffer that was saved by __XSaveScreen(), it also restore cursor position. After a call to __XRestScreen() the internal buffer is cleared.
  RESTORE SCREEN command is preprocessed into __XRestScreen() function during compile time. Note that RESTORE SCREEN FROM is preprocessed into RESTSCREEN() function.
  __XRestScreen() is a compatibility function, it is superseded by RESTSCREEN() which allow you to restore the screen from a variable.

Examples

          // save the screen, display list of files than restore the screen
          SAVE SCREEN
          DIR *.*
          WAIT
          RESTORE SCREEN

Status

  Ready

Compliance

  __XRestScreen() works exactly like CA-Clipper's __XRestScreen()

Platforms

  __XRestScreen() is part of the GT API, and supported only by some platforms.

Files

  Library is rtl

See Also

- __XRESTSCREEN()
- SAVE SCREEN
- __XSAVESCREEN()