# __XSaveScreen()

Save whole screen image and coordinate to an internal buffer

Syntax

  __XSaveScreen() --> NIL

Arguments

  none.

Returns

  __XSaveScreen() always return NIL.

Description

  __XSaveScreen() save the image of the whole screen into an internal buffer, it also save current cursor position. The information could later be restored by __XRestScreen(). Each call to __XSaveScreen() overwrite the internal buffer.
  SAVE SCREEN command is preprocessed into __XSaveScreen() function during compile time. Note that SAVE SCREEN TO is preprocessed into SAVESCREEN() function.
  __XSaveScreen() is a compatibility function, it is superseded by SAVESCREEN() which allow you to save part or all the screen into a variable.

Examples

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

Status

  Ready

Compliance

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

Platforms

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

Files

  Library is rtl

See Also

- RESTORE SCREEN
- RESTSCREEN()
- SAVESCREEN()