Kernel 8.0 APIs Banner [skip navigation]
Office of Information & Technology (OIT) Banner

SAVE^XGF(): Screen Save

Reference Type: Supported, Category: XGF Function Library, Integration Agreement: 3173

Description

This API saves a screen region. In order to save and restore screen regions, you must do all screen output using calls in the XGF Function Library output. If you instead use the M WRITE command for output, the screen contents cannot be saved and restored. Also, a call to the PREP^XGF(): Screen/Keyboard Setup API must be made at some point prior to calling SAVE^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

  SAVE^XGF(top,left,bottom,right,save_root)

Input Parameters

top:

(required) Top screen coordinate for box.

left:

(required) Left screen coordinate for box.

bottom:

(required) Bottom screen coordinate for box.

right:

(required) Right screen coordinate for box.

save_root:

(required) Global/local array node, closed root form.

Output

$x and $y:

Left unchanged.

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

Example

For example, to save the screen contents between rows 5 and 15 and columns 20 and 60 in the SELECT local array, do the following:

>D SAVE^XGF(5,20,15,60,"SELECT")

 


VA (Internet) / VA(Intranet) / OI / PD / Site Map / Terms of Use / VA Privacy Policy / Accessibility

Reviewed/Updated: August 26, 2011

If you have questions, need more information, or are having accessibility problems with this website, please contact us by E-Mail: Webmasters, Phone: 510-768-6800, or FAX: 510-768-6850.