RESTORE^XGF(): Screen Restore

Reference Type: Supported, Category: XGF Function Library, ICR#: 3173

Description

The RESTORE^XGF API restores a previously saved screen region. You can save screen regions using the WIN^XGF(): Screen Text Window and SAVE^XGF(): Screen Save APIs. RESTORE^XGF restores the saved screen region in the same screen position as the screen region was saved from.

A call to the PREP^XGF(): Screen/Keyboard Setup API must be made at some point prior to calling RESTORE^XGF.

Specify the array node under which to save the overlaid screen region in closed root and fully resolved form (i.e., closed right parenthesis and with variable references such as $J fully resolved). Using M $NAME function is a quick way to pass fully resolved node specifications.

Format

  RESTORE^XGF(save_root)

Input Parameters

Output Variables

NOTE: See also: CLEAR^XGF(): Screen Clear Region, SAVE^XGF(): Screen Save, and WIN^XGF(): Screen Text Window APIs.

Example

To restore the screen contents saved to the local array SELECT to their original position, do the following:

>D RESTORE^XGF("SELECT")